> ## Documentation Index
> Fetch the complete documentation index at: https://openrouter-d02e98a0-speakeasy-sdk-regen-1791559052.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Update an API key
> Update an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys).
Set `workspace_id` to move the key to another workspace. The key keeps its value, and any other fields in the same request are applied atomically with the move. Guardrail selections move with the key; other workspace-scoped settings (presets, BYOK keys, broadcast destinations, routing rules) do not. A move into or out of a HIPAA workspace is refused with `403`. In an organization, if the key's creator is not a member of a non-default target workspace, the request fails with `409`; add them to the workspace first.
The request body accepts only the fields listed below, and unrecognized fields are ignored. If the body contains none of the accepted fields, the request fails with `400` and the message `No update fields provided`.
## OpenAPI
````yaml /openapi/openapi.yaml patch /keys/{hash}
openapi: 3.1.0
info:
contact:
email: support@openrouter.ai
name: OpenRouter Support
url: https://openrouter.ai/docs
description: OpenAI-compatible API with additional OpenRouter features
license:
name: MIT
url: https://opensource.org/licenses/MIT
title: OpenRouter API
version: 1.0.0
servers:
- description: Production server
url: https://openrouter.ai/api/v1
x-speakeasy-server-id: production
security:
- apiKey: []
tags:
- description: API key management endpoints
name: API Keys
- description: Analytics and usage endpoints
name: Analytics
- description: Anthropic Messages endpoints
name: Anthropic Messages
- description: BYOK endpoints
name: BYOK
- description: >-
Submit, list, poll, and delete asynchronous batches of inference requests.
See https://openrouter.ai/docs/batch-quickstart.
name: Batch
- description: Benchmarks endpoints
name: Benchmarks
- description: Chat completion endpoints
name: Chat
- description: Task classification market-share endpoints
name: Classifications
- description: Containers endpoints
name: Containers
- description: Credit management endpoints
name: Credits
- description: >-
Public OpenRouter usage datasets. Data returned by these endpoints is
licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/):
reuse and republish it, including commercially, with attribution to
OpenRouter.
name: Datasets
- description: Text embedding endpoints
name: Embeddings
- description: End Users endpoints
name: End Users
- description: Endpoint information
name: Endpoints
- description: Files endpoints
name: Files
- description: Generation history endpoints
name: Generations
- description: Guardrails endpoints
name: Guardrails
- description: Images endpoints
name: Images
- description: >-
Create, inspect, update, provision, suspend and delete OpenRouter interns
through an API key, and talk to them: the chat route streams
OpenAI-compatible completions from one intern, pausing as an
`openrouter.provide_input` tool call when the intern needs your permission
or an answer. Available to interns programme members; other callers
receive 404. See https://openrouter.ai/docs/guides/ori/intern-chat.
name: Interns
- description: Model information endpoints
name: Models
- description: OAuth authentication endpoints
name: OAuth
- description: Observability endpoints
name: Observability
- description: Organization endpoints
name: Organization
- description: Presets endpoints
name: Presets
- description: Private Endpoints endpoints
name: Private Endpoints
- description: Provider information endpoints
name: Providers
- description: Rerank endpoints
name: Rerank
- description: OpenAI-compatible Responses API endpoints
name: Responses
- description: >-
Management endpoints for SCIM group-to-workspace mappings, authenticated
with a management key. These are not the SCIM 2.0 connector endpoints for
your identity provider. In your identity provider, enter the SCIM endpoint
URL shown when you enable provisioning under Settings > Members > SCIM
Mappings. See
https://openrouter.ai/docs/guides/features/scim-mappings#set-up-provisioning.
name: SCIM
- description: Speech-to-text endpoints
name: STT
x-displayName: Transcriptions
- description: >-
System One endpoints for models such as Jev, compatible with the TypeSafe
SDKs. See https://openrouter.ai/docs/guides/community/typesafe-sdk.
name: SystemOne
x-displayName: System One
- description: Text-to-speech endpoints
name: TTS
x-displayName: Speech
- description: >-
The catalog of server tools OpenRouter runs on behalf of a model: accepted
`tools[].type` spellings per API format, engines and pricing, and which
endpoints run each tool natively. See
https://openrouter.ai/docs/guides/features/server-tools.
name: Tools
- description: >-
Store host-bound secrets for a workspace or for one intern. Scope is
selected by the API key. Responses return metadata only, never secret
values. See https://openrouter.ai/docs/guides/ori/vault.
name: Vault
- description: Video Generation endpoints
name: Video Generation
- description: Workspaces endpoints
name: Workspaces
- description: Alpha feature endpoints for Decisions requests
name: alpha.decisions
externalDocs:
description: OpenRouter Documentation
url: https://openrouter.ai/docs
paths:
/keys/{hash}:
patch:
tags:
- API Keys
summary: Update an API key
description: >-
Update an existing API key. Authenticate with a [management
key](/docs/guides/overview/auth/management-api-keys).
Set `workspace_id` to move the key to another workspace. The key keeps
its value, and any other fields in the same request are applied
atomically with the move. Guardrail selections move with the key; other
workspace-scoped settings (presets, BYOK keys, broadcast destinations,
routing rules) do not. A move into or out of a HIPAA workspace is
refused with `403`. In an organization, if the key's creator is not a
member of a non-default target workspace, the request fails with `409`;
add them to the workspace first.
The request body accepts only the fields listed below, and unrecognized
fields are ignored. If the body contains none of the accepted fields,
the request fails with `400` and the message `No update fields
provided`.
operationId: updateKeys
parameters:
- description: The hash identifier of the API key to update
in: path
name: hash
required: true
schema:
description: The hash identifier of the API key to update
example: f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
type: string
requestBody:
content:
application/json:
example:
disabled: false
include_byok_in_limit: true
limit: 75
limit_reset: daily
name: Updated API Key Name
schema:
example:
disabled: false
include_byok_in_limit: true
limit: 75
limit_reset: daily
name: Updated API Key Name
properties:
disabled:
description: Whether to disable the API key
example: false
type: boolean
include_byok_in_limit:
description: Whether to include BYOK usage in the limit
example: true
type: boolean
limit:
description: New spending limit for the API key in USD
example: 75
format: double
type:
- number
- 'null'
limit_reset:
description: >-
New limit reset type for the API key (daily, weekly,
monthly, or null for no reset). Resets happen automatically
at midnight UTC, and weeks are Monday through Sunday.
enum:
- daily
- weekly
- monthly
- null
example: daily
type:
- string
- 'null'
name:
description: New name for the API key
example: Updated API Key Name
type: string
workspace_id:
description: >-
Move the API key to this workspace. The key keeps its value;
guardrail selections move with it, while other
workspace-scoped settings (presets, BYOK keys, broadcast
destinations, routing rules) do not. Sending the key's
current workspace is a no-op.
example: 0df9e665-d932-5740-b2c7-b52af166bc11
format: uuid
type: string
type: object
required: true
responses:
'200':
content:
application/json:
example:
data:
byok_usage: 17.38
byok_usage_daily: 17.38
byok_usage_monthly: 17.38
byok_usage_weekly: 17.38
created_at: '2025-08-24T10:30:00Z'
creator_user_id: user_2dHFtVWx2n56w6HkM0000000000
disabled: false
expires_at: null
hash: >-
f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
include_byok_in_limit: true
label: Updated API Key Name
last_used_at: '2026-09-15T15:45:00Z'
limit: 75
limit_remaining: 49.5
limit_reset: daily
name: Updated API Key Name
updated_at: '2025-08-24T16:00:00Z'
usage: 25.5
usage_daily: 25.5
usage_monthly: 25.5
usage_weekly: 25.5
workspace_id: 0df9e665-d932-5740-b2c7-b52af166bc11
schema:
example:
data:
byok_usage: 17.38
byok_usage_daily: 17.38
byok_usage_monthly: 17.38
byok_usage_weekly: 17.38
created_at: '2025-08-24T10:30:00Z'
creator_user_id: user_2dHFtVWx2n56w6HkM0000000000
disabled: false
expires_at: null
external_user: null
hash: >-
f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
include_byok_in_limit: true
label: Updated API Key Name
last_used_at: '2026-09-15T15:45:00Z'
limit: 75
limit_remaining: 49.5
limit_reset: daily
name: Updated API Key Name
updated_at: '2025-08-24T16:00:00Z'
usage: 25.5
usage_daily: 25.5
usage_monthly: 25.5
usage_weekly: 25.5
workspace_id: 0df9e665-d932-5740-b2c7-b52af166bc11
properties:
data:
description: The updated API key information
example:
byok_usage: 17.38
byok_usage_daily: 17.38
byok_usage_monthly: 17.38
byok_usage_weekly: 17.38
created_at: '2025-08-24T10:30:00Z'
creator_user_id: user_2dHFtVWx2n56w6HkM0000000000
disabled: false
expires_at: '2027-12-31T23:59:59Z'
external_user: null
hash: >-
f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
include_byok_in_limit: false
label: sk-or-v1-0e6...1c96
last_used_at: '2026-09-15T15:45:00Z'
limit: 100
limit_remaining: 74.5
limit_reset: monthly
name: My Production Key
updated_at: '2025-08-24T15:45:00Z'
usage: 25.5
usage_daily: 25.5
usage_monthly: 25.5
usage_weekly: 25.5
workspace_id: 0df9e665-d932-5740-b2c7-b52af166bc11
properties:
byok_usage:
description: Total external BYOK usage (in USD) for the API key
example: 17.38
format: double
type: number
byok_usage_daily:
description: External BYOK usage (in USD) for the current UTC day
example: 17.38
format: double
type: number
byok_usage_monthly:
description: External BYOK usage (in USD) for current UTC month
example: 17.38
format: double
type: number
byok_usage_weekly:
description: >-
External BYOK usage (in USD) for the current UTC week
(Monday-Sunday)
example: 17.38
format: double
type: number
created_at:
description: ISO 8601 timestamp of when the API key was created
example: '2025-08-24T10:30:00Z'
type: string
creator_user_id:
description: >-
The user ID of the key creator. For organization-owned
keys, this is the member who created the key. For
individual users, this is the user's own ID.
example: user_2dHFtVWx2n56w6HkM0000000000
type:
- string
- 'null'
disabled:
description: Whether the API key is disabled
example: false
type: boolean
expires_at:
description: >-
ISO 8601 UTC timestamp when the API key expires, or
null if no expiration
example: '2027-12-31T23:59:59Z'
format: date-time
type:
- string
- 'null'
external_user:
description: Partner's end-user identifier used for attribution.
example: null
type:
- string
- 'null'
hash:
description: Unique hash identifier for the API key
example: >-
f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943
type: string
include_byok_in_limit:
description: >-
Whether to include external BYOK usage in the credit
limit
example: false
type: boolean
label:
description: Human-readable label for the API key
example: sk-or-v1-0e6...1c96
type: string
last_used_at:
description: >-
ISO 8601 UTC timestamp of the most recent usage
recorded for the API key, or null if no usage has been
recorded since the end of 2025
example: '2026-09-15T15:45:00Z'
format: date-time
type:
- string
- 'null'
limit:
description: Spending limit for the API key in USD
example: 100
format: double
type:
- number
- 'null'
limit_remaining:
description: Remaining spending limit in USD
example: 74.5
format: double
type:
- number
- 'null'
limit_reset:
description: Type of limit reset for the API key
example: monthly
type:
- string
- 'null'
name:
description: Name of the API key
example: My Production Key
type: string
updated_at:
description: >-
ISO 8601 timestamp of when the API key was last
updated
example: '2025-08-24T15:45:00Z'
type:
- string
- 'null'
usage:
description: Total OpenRouter credit usage (in USD) for the API key
example: 25.5
format: double
type: number
usage_daily:
description: >-
OpenRouter credit usage (in USD) for the current UTC
day
example: 25.5
format: double
type: number
usage_monthly:
description: >-
OpenRouter credit usage (in USD) for the current UTC
month
example: 25.5
format: double
type: number
usage_weekly:
description: >-
OpenRouter credit usage (in USD) for the current UTC
week (Monday-Sunday)
example: 25.5
format: double
type: number
workspace_id:
description: The workspace ID this API key belongs to.
example: 0df9e665-d932-5740-b2c7-b52af166bc11
type: string
required:
- hash
- name
- label
- disabled
- limit
- limit_remaining
- limit_reset
- include_byok_in_limit
- usage
- usage_daily
- usage_weekly
- usage_monthly
- byok_usage
- byok_usage_daily
- byok_usage_weekly
- byok_usage_monthly
- created_at
- updated_at
- last_used_at
- external_user
- creator_user_id
- workspace_id
type: object
required:
- data
type: object
description: API key updated successfully
'400':
content:
application/json:
examples:
invalid_parameters:
summary: Invalid request parameters
value:
error:
code: 400
message: Invalid request parameters
no_update_fields:
description: >-
Returned when the body contains none of the accepted fields,
for example `{"label": "..."}`.
summary: No accepted fields in the request body
value:
error:
code: 400
message: No update fields provided
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request - Invalid request parameters or malformed input
'401':
content:
application/json:
example:
error:
code: 401
message: Missing Authentication header
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized - Authentication required or invalid credentials
'403':
content:
application/json:
example:
error:
code: 403
message: Only management keys can perform this operation
schema:
$ref: '#/components/schemas/ForbiddenResponse'
description: Forbidden - Authentication successful but insufficient permissions
'404':
content:
application/json:
example:
error:
code: 404
message: Resource not found
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found - Resource does not exist
'409':
content:
application/json:
example:
error:
code: 409
message: >-
The API key creator is not a member of the target workspace.
Add them to the workspace, then retry.
schema:
$ref: '#/components/schemas/ConflictResponse'
description: Conflict - Resource conflict or concurrent modification
'429':
content:
application/json:
example:
error:
code: 429
message: Rate limit exceeded
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Too Many Requests - Rate limit exceeded
'500':
content:
application/json:
example:
error:
code: 500
message: Internal Server Error
schema:
$ref: '#/components/schemas/InternalServerResponse'
description: Internal Server Error - Unexpected server error
components:
schemas:
BadRequestResponse:
description: Bad Request - Invalid request parameters or malformed input
example:
error:
code: 400
message: Invalid request parameters
properties:
error:
$ref: '#/components/schemas/BadRequestResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
UnauthorizedResponse:
description: Unauthorized - Authentication required or invalid credentials
example:
error:
code: 401
message: Missing Authentication header
properties:
error:
$ref: '#/components/schemas/UnauthorizedResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
ForbiddenResponse:
description: Forbidden - Authentication successful but insufficient permissions
example:
error:
code: 403
message: Only management keys can perform this operation
properties:
error:
$ref: '#/components/schemas/ForbiddenResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
NotFoundResponse:
description: Not Found - Resource does not exist
example:
error:
code: 404
message: Resource not found
properties:
error:
$ref: '#/components/schemas/NotFoundResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
ConflictResponse:
description: Conflict - Resource conflict or concurrent modification
example:
error:
code: 409
message: Resource conflict. Please try again later.
properties:
error:
$ref: '#/components/schemas/ConflictResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
TooManyRequestsResponse:
description: Too Many Requests - Rate limit exceeded
example:
error:
code: 429
message: Rate limit exceeded
properties:
error:
$ref: '#/components/schemas/TooManyRequestsResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
InternalServerResponse:
description: Internal Server Error - Unexpected server error
example:
error:
code: 500
message: Internal Server Error
properties:
error:
$ref: '#/components/schemas/InternalServerResponseErrorData'
openrouter_metadata:
additionalProperties: {}
type:
- object
- 'null'
user_id:
type:
- string
- 'null'
required:
- error
type: object
BadRequestResponseErrorData:
description: Error data for BadRequestResponse
example:
code: 400
message: Invalid request parameters
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
UnauthorizedResponseErrorData:
description: Error data for UnauthorizedResponse
example:
code: 401
message: Missing Authentication header
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
ForbiddenResponseErrorData:
description: Error data for ForbiddenResponse
example:
code: 403
message: Only management keys can perform this operation
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
NotFoundResponseErrorData:
description: Error data for NotFoundResponse
example:
code: 404
message: Resource not found
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
ConflictResponseErrorData:
description: Error data for ConflictResponse
example:
code: 409
message: Resource conflict. Please try again later.
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
TooManyRequestsResponseErrorData:
description: Error data for TooManyRequestsResponse
example:
code: 429
message: Rate limit exceeded
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
InternalServerResponseErrorData:
description: Error data for InternalServerResponse
example:
code: 500
message: Internal Server Error
properties:
code:
type: integer
message:
type: string
metadata:
additionalProperties: {}
type:
- object
- 'null'
required:
- code
- message
type: object
securitySchemes:
apiKey:
description: API key as bearer token in Authorization header
scheme: bearer
type: http
````