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

# Describe the calling API key

> The user and organization the key belongs to, its scopes and when it expires. Needs only a valid key.



## OpenAPI

````yaml /openapi/ext-api-v1.json get /me
openapi: 3.0.0
info:
  title: Healos External API
  version: 1.0.0
  description: >-
    External API for managing patients, documents, and appointments, listing
    providers and note templates, pulling clinical notes (with transcript and
    patient context), and running insurance eligibility checks.
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /me:
    get:
      tags:
        - Account
      summary: Describe the calling API key
      description: >-
        The user and organization the key belongs to, its scopes and when it
        expires. Needs only a valid key.
      responses:
        '200':
          description: The key's identity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    MeResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            user:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
                  nullable: true
                email:
                  type: string
                  nullable: true
              required:
                - id
                - name
                - email
            org:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
                  nullable: true
              required:
                - id
                - name
            scopes:
              type: array
              items:
                type: string
              example:
                - notes:read
            key:
              type: object
              properties:
                prefix:
                  type: string
                  example: hlsk_AbCd
                label:
                  type: string
                  nullable: true
                expires_at:
                  type: string
                  nullable: true
                created_at:
                  type: string
                  nullable: true
              required:
                - prefix
                - label
                - expires_at
                - created_at
          required:
            - user
            - org
            - scopes
            - key
      required:
        - data
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    RateLimitError:
      type: object
      properties:
        error:
          type: string
          example: Rate limit exceeded. Please retry after the window resets.
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from /api/v1/ext-api-keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.