Skip to main content
PATCH
Update an API key

Authorizations

Authorization
string
header
required

An API key from frogbot deploy's sign-in, /api/cli/device/token, or the API keys page.

Path Parameters

id
string
required

The API key's id.

Body

application/json
id
string
name
string
owner
string

The id of a users document.

prefix
string
lastUsedAt
string<date-time>
revokedAt
string<date-time>
expiresAt
string<date-time>

The key stops working at this time. Empty when it never expires.

canMint
boolean

Requests made with this key can mint and rotate keys no broader than it.

mintedBy
string

The key that minted this one. Empty when a signed-in session did.

totalCostUSD
number
workspace
string

The one workspace this key works in. Empty for a CLI sign-in, which works in all of its owner's.

mcpConnection
string

The MCP connection that made this key. Disconnecting it revokes the key unless the person unchecks that.

firmwareKeyId
string
legacyScheme
enum<string>
Available options:
sha256-hex,
firmware
models
enum<string>[]
Available options:
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
number
spendCounter
string

The id of a plugin-ai-policy-spend document.

spendThisPeriodUSD
number

Response

OK

doc
object
message
string