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

# Inspect API key

> Read the key organization, scopes, and expiry. Does not return its secret.



## OpenAPI

````yaml /openapi/public-api.json get /v1/auth/api-key
openapi: 3.1.0
info:
  title: LiveFaces Session API
  version: 0.1.0
  description: >-
    Customer-facing session launch and lifecycle reference. Send API keys only
    from trusted server code.
servers:
  - url: https://api.livefaces.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Authentication
  - name: Sessions
  - name: Workflow runs
paths:
  /v1/auth/api-key:
    get:
      tags:
        - Authentication
      summary: Inspect API key
      description: >-
        Read the key organization, scopes, and expiry. Does not return its
        secret.
      operationId: inspectApiKey
      responses:
        '200':
          description: Successful response
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyPrincipal'
        '401':
          $ref: '#/components/responses/Error401'
components:
  headers:
    RequestId:
      description: Identifier for diagnosing this request.
      schema:
        type: string
  schemas:
    ApiKeyPrincipal:
      type: object
      properties:
        api_key_id:
          type: string
          description: Identifier of the authenticated key.
          format: uuid
        organization_id:
          type: string
          description: Organization owning the key.
          format: uuid
        scopes:
          type: array
          items:
            type: string
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - api_key_id
        - organization_id
        - scopes
        - expires_at
      additionalProperties: false
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Application error code.
        detail:
          description: Error description or structured validation details.
        request_id:
          type: string
          description: Request identifier for support.
      required:
        - code
        - detail
        - request_id
      additionalProperties: true
  responses:
    Error401:
      description: Invalid, expired, or revoked API key.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Organization API key. Keep it on your server.

````

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