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

# Read an API key



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json get /api/api-keys/{id}
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/api-keys/{id}:
    get:
      tags:
        - API keys
      summary: Read an API key
      parameters:
        - name: id
          in: path
          required: true
          description: The API key's id.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeys'
        '400':
          description: '`invalid_request`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: '`forbidden`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: '`not_found`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    ApiKeys:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        owner:
          type: string
          description: The id of a users document.
        prefix:
          type: string
        lastUsedAt:
          type: string
          format: date-time
        revokedAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
          description: The key stops working at this time. Empty when it never expires.
        canMint:
          type: boolean
          description: >-
            Requests made with this key can mint and rotate keys no broader than
            it.
        mintedBy:
          type: string
          description: The key that minted this one. Empty when a signed-in session did.
        totalCostUSD:
          type: number
        workspace:
          type: string
          description: >-
            The one workspace this key works in. Empty for a CLI sign-in, which
            works in all of its owner's.
        mcpConnection:
          type: string
          description: >-
            The MCP connection that made this key. Disconnecting it revokes the
            key unless the person unchecks that.
        firmwareKeyId:
          type: string
        legacyScheme:
          type: string
          enum:
            - sha256-hex
            - firmware
        models:
          type: array
          items:
            type: string
            enum:
              - bedrock/us.anthropic.claude-fable-5
              - bedrock/us.anthropic.claude-fable-5-1
              - bedrock/us.anthropic.claude-fable-5-2
              - bedrock/us.anthropic.claude-haiku-4-5-20251001-v1:0
              - bedrock/us.anthropic.claude-haiku-5-5
              - bedrock/us.anthropic.claude-opus-4-5-20251101-v1:0
              - bedrock/us.anthropic.claude-opus-4-6-v1
              - bedrock/us.anthropic.claude-opus-4-7
              - bedrock/us.anthropic.claude-opus-4-8
              - bedrock/us.anthropic.claude-opus-5
              - bedrock/us.anthropic.claude-opus-5-5
              - bedrock/us.anthropic.claude-sonnet-4-6
              - bedrock/us.anthropic.claude-sonnet-5
              - bedrock/us.anthropic.claude-sonnet-5-5
              - fireworks-compat/accounts/fireworks/models/deepseek-r1-0528
              - fireworks-compat/accounts/fireworks/models/deepseek-v4-pro-0813
              - fireworks-compat/accounts/fireworks/models/glm-5p2
              - fireworks-compat/accounts/fireworks/models/gpt-oss-120b
              - fireworks-compat/accounts/fireworks/models/gpt-oss-20b
              - fireworks-compat/accounts/fireworks/models/kimi-k2-thinking
              - fireworks-compat/accounts/fireworks/models/kimi-k2p6
              - fireworks-compat/accounts/fireworks/models/kimi-k2p7-code
              - fireworks-compat/accounts/fireworks/models/qwen3p7-plus
              - fireworks/accounts/fireworks/models/deepseek-v4p1-flash
              - fireworks/accounts/fireworks/models/deepseek-v4p1-flash-1017
              - fireworks/accounts/fireworks/models/ember-1
              - fireworks/accounts/fireworks/models/glm-5p3
              - fireworks/accounts/fireworks/models/glm-5p3-flash
              - fireworks/accounts/fireworks/models/kimi-k3
              - fireworks/accounts/fireworks/models/kimi-k3p1-pro
              - fireworks/accounts/fireworks/models/minimax-m3
              - fireworks/accounts/fireworks/models/minimax-m3p1-flash
              - fireworks/accounts/fireworks/models/muse-spark-open
              - fireworks/accounts/fireworks/models/qwen3p8-2p4t-a95b
              - fireworks/accounts/fireworks/models/qwen3p8-max
              - fireworks/accounts/fireworks/routers/deepseek-flash-latest
              - >-
                fireworks/accounts/fireworks/routers/deepseek-v4p1-flash-1017-spot
              - >-
                fireworks/accounts/fireworks/routers/deepseek-v4p1-flash-1017-ultrafast
              - fireworks/accounts/fireworks/routers/deepseek-v4p1-flash-spot
              - fireworks/accounts/fireworks/routers/glm-5p3-fast
              - fireworks/accounts/fireworks/routers/glm-5p3-spot
              - fireworks/accounts/fireworks/routers/glm-fast-latest
              - fireworks/accounts/fireworks/routers/glm-flash-latest
              - fireworks/accounts/fireworks/routers/glm-latest
              - fireworks/accounts/fireworks/routers/kimi-fast-latest
              - fireworks/accounts/fireworks/routers/kimi-k3-fast
              - fireworks/accounts/fireworks/routers/kimi-k3-spot
              - fireworks/accounts/fireworks/routers/kimi-latest
              - fireworks/accounts/fireworks/routers/minimax-latest
              - fireworks/accounts/fireworks/routers/qwen-max-latest
              - google-compat/text-embedding-004
              - google/deep-research-max-preview-04-2026
              - google/deep-research-preview-04-2026
              - google/gemini-2.5-computer-use-preview-10-2025
              - google/gemini-2.5-flash
              - google/gemini-2.5-flash-lite
              - google/gemini-2.5-flash-preview-tts
              - google/gemini-2.5-pro
              - google/gemini-2.5-pro-preview-tts
              - google/gemini-3-flash-preview
              - google/gemini-3-pro-image
              - google/gemini-3.1-flash-image
              - google/gemini-3.1-flash-lite
              - google/gemini-3.1-flash-lite-image
              - google/gemini-3.1-flash-live-preview
              - google/gemini-3.1-flash-tts-preview
              - google/gemini-3.1-pro-preview
              - google/gemini-3.1-pro-preview-customtools
              - google/gemini-3.5-flash
              - google/gemini-3.5-flash-lite
              - google/gemini-3.5-live-translate-preview
              - google/gemini-3.5-transcribe
              - google/gemini-3.6-flash
              - google/gemini-3.7-flash
              - google/gemini-3.8-flash
              - google/gemini-4-argon
              - google/gemini-4-carbon
              - google/gemini-4-hydrogen
              - google/gemini-embedding-001
              - google/gemini-embedding-2
              - google/gemini-flash-latest
              - google/gemini-flash-lite-latest
              - google/gemini-omni-flash-preview
              - google/gemini-pro-latest
              - google/gemma-4-26b-a4b-it
              - google/gemma-4-31b-it
              - google/lyria-3-clip-preview
              - google/lyria-3-pro-preview
              - openai/gpt-4.1
              - openai/gpt-4.1-mini
              - openai/gpt-4o
              - openai/gpt-4o-2024-08-06
              - openai/gpt-4o-2024-11-20
              - openai/gpt-4o-mini
              - openai/gpt-4o-mini-transcribe
              - openai/gpt-4o-transcribe
              - openai/gpt-5
              - openai/gpt-5-mini
              - openai/gpt-5-nano
              - openai/gpt-5-pro
              - openai/gpt-5.1
              - openai/gpt-5.2
              - openai/gpt-5.2-pro
              - openai/gpt-5.3-codex
              - openai/gpt-5.3-codex-spark
              - openai/gpt-5.4
              - openai/gpt-5.4-mini
              - openai/gpt-5.4-nano
              - openai/gpt-5.4-pro
              - openai/gpt-5.5
              - openai/gpt-5.5-pro
              - openai/gpt-5.6
              - openai/gpt-5.6-luna
              - openai/gpt-5.6-sol
              - openai/gpt-5.6-terra
              - openai/gpt-6-astra
              - openai/gpt-6-luna
              - openai/gpt-6-sol
              - openai/gpt-6.1-sol
              - openai/gpt-6.1-terra
              - openai/gpt-daybreak-blue-latest
              - openai/gpt-daybreak-red-latest
              - openai/gpt-image-2
              - openai/gpt-realtime-2.1
              - openai/o3
              - openai/o3-pro
              - openai/text-embedding-3-large
              - openai/text-embedding-3-small
              - openai/text-embedding-ada-002
              - openai/whisper-1
              - voyage-compat/voyage-4
              - voyage-compat/voyage-4-large
              - voyage-compat/voyage-4-lite
              - voyage-compat/voyage-code-2
              - voyage-compat/voyage-code-3
              - voyage-compat/voyage-context-3
              - voyage-compat/voyage-finance-2
              - voyage-compat/voyage-law-2
              - voyage/voyage-3
              - voyage/voyage-3-lite
              - voyage/voyage-code-3
              - xai-compat/grok-4-1-fast-non-reasoning
              - xai-compat/grok-4-1-fast-reasoning
              - xai-compat/grok-code-fast-1
              - xai/grok-4.20-0309-non-reasoning
              - xai/grok-4.20-0309-reasoning
              - xai/grok-4.20-multi-agent-0309
              - xai/grok-4.3
              - xai/grok-4.5
              - xai/grok-4.6
              - xai/grok-4.7
              - xai/grok-build-0.1
              - xai/grok-imagine-image
              - xai/grok-imagine-video
              - xai/grok-imagine-video-1.5
              - xai/grok-imagine-video-1.5-lite
        monthlyBudget:
          type: number
        spendCounter:
          type: string
          description: The id of a plugin-ai-policy-spend document.
        spendThisPeriodUSD:
          type: number
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

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