> ## Documentation Index
> Fetch the complete documentation index at: https://docs.custral.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introspect the current key

> "Does my key work, and what can it do?" — the canonical first request an integration makes. Any valid, active key may call it; **no scope required**. Never returns the secret, only non-sensitive metadata.



## OpenAPI

````yaml /openapi-v1.json get /v1/me
openapi: 3.1.0
info:
  title: Custral API
  version: v1
  description: >-
    The curated, versioned, API-key-authenticated public REST surface (`/v1`).
    Every endpoint here is what the official SDKs (`@custral/sdk`) and the MCP
    server are built on. Authenticate with a secret API key (`sk_…`) created in
    **Settings → Applications**.
  contact:
    name: Custral Support
    email: hello@custral.com
    url: https://custral.com
  license:
    name: Proprietary
    url: https://custral.com
servers:
  - url: https://api.custral.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Introspect the calling API key.
  - name: Records
    description: Create, list, retrieve, and update records on any object.
  - name: Objects
    description: Read the object (table) schema of your workspace.
  - name: Conversations
    description: View, manage, and ingest conversations and their messages.
  - name: MCP
    description: Introspect the Model Context Protocol tool surface for a key.
  - name: Documents
    description: Read record notes / page documents as markdown.
paths:
  /v1/me:
    get:
      tags:
        - Identity
      summary: Introspect the current key
      description: >-
        "Does my key work, and what can it do?" — the canonical first request an
        integration makes. Any valid, active key may call it; **no scope
        required**. Never returns the secret, only non-sensitive metadata.
      operationId: getIdentity
      responses:
        '200':
          description: The key's non-sensitive metadata.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Identity'
                  reqId:
                    $ref: '#/components/schemas/RequestId'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Identity:
      type: object
      description: The `GET /v1/me` payload — what the calling key can do.
      properties:
        orgId:
          type:
            - string
            - 'null'
          example: org_123
        organizationName:
          type:
            - string
            - 'null'
          example: Acme Inc
        applicationId:
          type:
            - string
            - 'null'
          example: app_123
        keyId:
          type:
            - string
            - 'null'
          example: key_123
        keyPreview:
          type:
            - string
            - 'null'
          description: A masked preview of the key (never the full secret).
          example: sk_live_…a1b2
        environment:
          type:
            - string
            - 'null'
          enum:
            - live
            - test
            - null
          example: live
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/ApiKeyScope'
    RequestId:
      type: string
      description: >-
        A per-request id (`req_…`). Quote it to support when reporting a
        problem.
      example: req_2a1f9c8e7b6d5
    ApiKeyScope:
      type: string
      description: A permission a key can hold.
      enum:
        - records:read
        - records:write
        - objects:read
        - documents:read
        - conversations:read
        - conversations:write
        - property_agents:read
        - property_agents:write
        - tasks:read
        - usage:read
        - usage:write
        - webhooks:manage
        - mcp:read
        - mcp:write
    Error:
      type: object
      description: >-
        The failure envelope. Every error carries a machine-readable `code` and
        the `reqId` of the failing request.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: insufficient_scope
          required:
            - code
        reqId:
          $ref: '#/components/schemas/RequestId'
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        The API key is missing, unknown, inactive, or expired (`code:
        invalid_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
            reqId: req_2a1f9c8e7b6d5
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: sk_...
      description: >-
        A Custral **secret** API key (`sk_…`), created in Settings →
        Applications. Sent as `Authorization: Bearer sk_…`. The `X-Api-Key:
        sk_…` header is also accepted and takes precedence. Never expose a
        secret key in a browser.

````

## Related topics

- [Applications & keys](/dev/api-reference/applications.md)
- [Presentation Templates](/blocks/presentations/templates.md)
- [Notes](/blocks/embedded/object/notes.md)
- [Applications & API keys](/dev/applications.md)
- [Install the widget](/comms/chat/widget-install.md)