{
"error": {
"message": "The requested resource was not found.",
"type": "not_found_error",
"param": null,
"code": "resource_not_found"
}
}
Change a key’s name, rate limit, expiry, or active state.Requires keys:write scope. Naturally idempotent.
Scopes are immutable after creation. Only name, rate limit, expiry, and active state can be updated.
Restrictive changes (lowering rate limit, shortening expiry, disabling) may return 202 with propagation_status: "pending" while the change takes effect.
All parameters, request/response schemas, and examples are auto-generated from the OpenAPI specification.
Authorizations
Authorization
string
header
required
API key authentication.
Keys start with ak_ prefix.
Example: Authorization: Bearer ak_live_xxxxxxxxxxxx
Path Parameters
workspace_id
string<uuid>
required
Workspace identifier
api_key_id
string<uuid>
required
API key identifier
Body
application/json
name
string
Human-readable name for the key
Required string length: 1 - 255
rate_limit_rpm
integer
Per-key rate limit in requests per minute (minimum 1)
Required range: x >= 1
expires_at
string<date-time> | null
Expiration timestamp. Send null to remove expiration.
is_active
boolean
Whether the key is active
budget
object
Budget configuration for an API key.
Show child attributes
Response
OK
Updated API key metadata with optional propagation status.
id
string<uuid>
required
Unique identifier for the API key
workspace_id
string<uuid>
required
Workspace this key belongs to
name
string
required
Human-readable name for the key
key_prefix
string
required
Key prefix for identification
profile
enum<string>
required
Key profile derived from granted scopes
Available options:
inference,
management,
mixed
scopes
string[]
required
Granted permission scopes
is_active
boolean
required
Whether the key is currently active
created_at
string<date-time>
required
When the key was created
rate_limit_rpm
integer | null
Per-key rate limit in requests per minute
expires_at
string<date-time> | null
Expiration timestamp
last_used_at
string<date-time> | null
When the key was last used
created_by_key_id
string<uuid> | null
ID of the API key that created this key
propagation_status
enum<string> | null
Status of change propagation to edge caches
Available options:
pending,
null
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Auriko","colors":{"primary":"#4779EA","light":"#5A8AF0","dark":"#457CFD"},"logo":{"light":"https://mintcdn.com/auriko/ZctT69z8zlG3FLhm/logo/light.svg?fit=max\u0026auto=format\u0026n=ZctT69z8zlG3FLhm\u0026q=85\u0026s=9160396833137f89a62e6297d0da13e3","dark":"https://mintcdn.com/auriko/ZctT69z8zlG3FLhm/logo/dark.svg?fit=max\u0026auto=format\u0026n=ZctT69z8zlG3FLhm\u0026q=85\u0026s=a4b0a27dddb8e89f557c88810e83c0d6","href":"https://www.auriko.ai"},"favicon":"https://mintcdn.com/auriko/yhqJ6Vvvah9BLEHr/favicon.svg?fit=max\u0026auto=format\u0026n=yhqJ6Vvvah9BLEHr\u0026q=85\u0026s=c69b6b12a2be60ef2e4ca140b765fb07","api":{"openapi":"openapi.yaml","playground":{"display":"simple"},"examples":{"languages":["python","javascript","bash"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#FCFCFC","dark":"#121212"}},"navbar":{"links":[{"href":"https://auriko.ai/dashboard","label":"Dashboard"},{"href":"https://status.auriko.ai/","label":"Status"}],"primary":{"type":"button","label":"Get API Key","href":"https://auriko.ai/signup?redirectTo=%2Fdashboard%3Ftab%3Dapi-keys"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/auriko"}},"seo":{},"fonts":{"family":"Geist"},"integrations":{"ga4":{"measurementId":"G-T9E92EL136"},"posthog":{"apiKey":"phc_vN8XY29aw4p545BJEggF3maB23C8tRqidG5hpUP4Et6J","apiHost":"https://us.i.posthog.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"auriko","hasAudioNarration":false,"actualSubdomain":"auriko","customDomains":["docs.auriko.ai"],"gitSource":{"type":"github","owner":"auriko-ai","repo":"auriko","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6abd4cc98c699ce8aa4321dc","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":105},{"language":"default","tag":"Specifications","count":68},{"language":"default","tag":"Error code reference","count":63},{"language":"default","tag":"API Reference","count":50},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"SDK","count":10},{"language":"default","tag":"BYOK","count":7},{"language":"default","tag":"Frameworks","count":7},{"language":"default","tag":"API Keys","count":6},{"language":"default","tag":"Integrations","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"img.nav-logo{height:1.25rem!important}"}]}
{"page":{"pagePath":"api-reference/update-api-key","slug":"/api-reference/update-api-key","pageMetadata":{"title":"Update API key","description":"Updates an API key's mutable properties","openapi":"PATCH /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","last_verified":"2026-06-07","href":"/api-reference/update-api-key"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates an API key’s mutable properties\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Change a key’s name, rate limit, expiry, or active state.`}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`keys:write`}),` scope. Naturally idempotent.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Scopes are immutable after creation. Only name, rate limit, expiry, and active state can be updated.`})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Restrictive changes (lowering rate limit, shortening expiry, disabling) may return `,_jsx(_components.code,{children:`202`}),` with `,_jsx(_components.code,{children:`propagation_status: \"pending\"`}),` while the change takes effect.`]})}),`\n`,_jsxs(_components.p,{children:[`All parameters, request/response schemas, and examples are auto-generated from the `,_jsx(_components.a,{href:`/api-reference/overview`,children:`OpenAPI specification`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update API key","description":"Updates an API key's mutable properties","openapi":"PATCH /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","last_verified":"2026-06-07","href":"/api-reference/update-api-key"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateApiKey","x-stability":"preview","x-auriko-auth":{"credential_types":["api_key"],"api_key_scopes":["keys:write"],"scope_mode":"all","rate_limit_class":"management_writes","idempotency":"naturally_idempotent","audit_event":"api_key.updated","raw_secret_behavior":"none"},"summary":"Update API key","description":"Updates an API key's mutable properties","requestBody":"ffa6dbc7-9202-4c2d-9e70-95623d14e696","security":["9766af40-f971-4ab7-8723-8046c3e9898b"],"tags":["API Keys"],"responses":{"200":"16d63185-9470-466b-8ade-1b2cdf7a4b2a","202":"14c6fe7f-f7c6-408b-8354-7dd82a4f3229","400":"96cc9b21-623a-4d5d-b541-0aff850094ce","401":"9eda94ad-0b61-49d3-b7eb-d70704e81eda","404":"ac2f1368-137a-4588-86c5-ddcc552d391b"},"method":"patch","type":"path","servers":["7a684522-107c-44d9-947d-4e0fc7defa27"],"path":"/v1/workspaces/{workspace_id}/api-keys/{api_key_id}","baseUrlOptions":["https://api.auriko.ai"],"title":"Update API key","codeSamples":[],"requestExampleLanguages":["python","javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6276d568-f8b2-42b5-8fb9-289f4c5be206":{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Workspace identifier","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Workspace identifier"},"7cc0ce33-ee5a-424b-93f1-5dbc10b1c861":{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"API key identifier","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"API key identifier"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Human-readable name for the key","uniqueKey":"name","typeLabel":"string"},"rate_limit_rpm":{"type":"integer","minimum":1,"description":"Per-key rate limit in requests per minute (minimum 1)","uniqueKey":"rate_limit_rpm","typeLabel":"integer"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Expiration timestamp. Send null to remove expiration.","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Expiration timestamp. Send null to remove expiration.","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"},"is_active":{"type":"boolean","description":"Whether the key is active","uniqueKey":"is_active","typeLabel":"boolean"},"budget":{"type":"object","description":"Budget configuration for an API key.","properties":{"period":{"type":"string","enum":["daily","weekly","monthly"],"description":"Budget reset period","uniqueKey":"budget.period","typeLabel":"enum\u003cstring>"},"limit_usd":{"type":"number","format":"double","minimum":0.01,"maximum":1000000,"description":"Spend limit in USD (minimum $0.01, maximum $1,000,000, max 2 decimal places)","uniqueKey":"budget.limit_usd","typeLabel":"number\u003cdouble>"},"enforce":{"type":"boolean","description":"Whether to block requests when budget is exceeded","uniqueKey":"budget.enforce","typeLabel":"boolean"},"include_byok":{"type":"boolean","description":"Whether BYOK usage counts toward the budget","uniqueKey":"budget.include_byok","typeLabel":"boolean"}},"uniqueKey":"budget","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","rate_limit_rpm":2,"expires_at":"2023-11-07T05:31:56Z","is_active":true,"budget":{"limit_usd":500000.005,"enforce":true,"include_byok":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"16d63185-9470-466b-8ade-1b2cdf7a4b2a":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Updated API key metadata with optional propagation status.","required":["id","workspace_id","name","key_prefix","profile","scopes","is_active","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the API key","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"workspace_id":{"type":"string","format":"uuid","description":"Workspace this key belongs to","isRequired":true,"uniqueKey":"workspace_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Human-readable name for the key","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"key_prefix":{"type":"string","description":"Key prefix for identification","isRequired":true,"uniqueKey":"key_prefix","typeLabel":"string"},"profile":{"type":"string","enum":["inference","management","mixed"],"description":"Key profile derived from granted scopes","isRequired":true,"uniqueKey":"profile","typeLabel":"enum\u003cstring>"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"scopes.items.[INDEX]","typeLabel":"string"},"description":"Granted permission scopes","isRequired":true,"uniqueKey":"scopes","typeLabel":"string[]"},"is_active":{"type":"boolean","description":"Whether the key is currently active","isRequired":true,"uniqueKey":"is_active","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","description":"When the key was created","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"rate_limit_rpm":{"oneOf":[{"type":"integer","description":"Per-key rate limit in requests per minute","uniqueKey":"rate_limit_rpm.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Per-key rate limit in requests per minute","uniqueKey":"rate_limit_rpm.oneOf.1","typeLabel":"null"}],"uniqueKey":"rate_limit_rpm","typeLabel":"integer | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Expiration timestamp","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Expiration timestamp","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"},"last_used_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the key was last used","uniqueKey":"last_used_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the key was last used","uniqueKey":"last_used_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_used_at","typeLabel":"string\u003cdate-time> | null"},"created_by_key_id":{"oneOf":[{"type":"string","format":"uuid","description":"ID of the API key that created this key","uniqueKey":"created_by_key_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"ID of the API key that created this key","uniqueKey":"created_by_key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by_key_id","typeLabel":"string\u003cuuid> | null"},"propagation_status":{"oneOf":[{"type":"string","enum":["pending",null],"description":"Status of change propagation to edge caches","uniqueKey":"propagation_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pending",null],"description":"Status of change propagation to edge caches","uniqueKey":"propagation_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"propagation_status","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workspace_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","key_prefix":"\u003cstring>","profile":"inference","scopes":["\u003cstring>"],"is_active":true,"created_at":"2023-11-07T05:31:56Z","rate_limit_rpm":123,"expires_at":"2023-11-07T05:31:56Z","last_used_at":"2023-11-07T05:31:56Z","created_by_key_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","propagation_status":"pending"}}},"exampleType":"generated"}},"exampleType":"generated"},"14c6fe7f-f7c6-408b-8354-7dd82a4f3229":{"description":"Accepted — changes queued for propagation","content":{"application/json":{"schema":{"type":"object","description":"Updated API key metadata with optional propagation status.","required":["id","workspace_id","name","key_prefix","profile","scopes","is_active","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the API key","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"workspace_id":{"type":"string","format":"uuid","description":"Workspace this key belongs to","isRequired":true,"uniqueKey":"workspace_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Human-readable name for the key","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"key_prefix":{"type":"string","description":"Key prefix for identification","isRequired":true,"uniqueKey":"key_prefix","typeLabel":"string"},"profile":{"type":"string","enum":["inference","management","mixed"],"description":"Key profile derived from granted scopes","isRequired":true,"uniqueKey":"profile","typeLabel":"enum\u003cstring>"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"scopes.items.[INDEX]","typeLabel":"string"},"description":"Granted permission scopes","isRequired":true,"uniqueKey":"scopes","typeLabel":"string[]"},"is_active":{"type":"boolean","description":"Whether the key is currently active","isRequired":true,"uniqueKey":"is_active","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","description":"When the key was created","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"rate_limit_rpm":{"oneOf":[{"type":"integer","description":"Per-key rate limit in requests per minute","uniqueKey":"rate_limit_rpm.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Per-key rate limit in requests per minute","uniqueKey":"rate_limit_rpm.oneOf.1","typeLabel":"null"}],"uniqueKey":"rate_limit_rpm","typeLabel":"integer | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Expiration timestamp","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Expiration timestamp","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"},"last_used_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the key was last used","uniqueKey":"last_used_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the key was last used","uniqueKey":"last_used_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_used_at","typeLabel":"string\u003cdate-time> | null"},"created_by_key_id":{"oneOf":[{"type":"string","format":"uuid","description":"ID of the API key that created this key","uniqueKey":"created_by_key_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"ID of the API key that created this key","uniqueKey":"created_by_key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by_key_id","typeLabel":"string\u003cuuid> | null"},"propagation_status":{"oneOf":[{"type":"string","enum":["pending",null],"description":"Status of change propagation to edge caches","uniqueKey":"propagation_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pending",null],"description":"Status of change propagation to edge caches","uniqueKey":"propagation_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"propagation_status","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workspace_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","key_prefix":"\u003cstring>","profile":"inference","scopes":["\u003cstring>"],"is_active":true,"created_at":"2023-11-07T05:31:56Z","rate_limit_rpm":123,"expires_at":"2023-11-07T05:31:56Z","last_used_at":"2023-11-07T05:31:56Z","created_by_key_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","propagation_status":"pending"}}},"exampleType":"generated"}},"exampleType":"generated"},"96cc9b21-623a-4d5d-b541-0aff850094ce":{"description":"Invalid parameter value","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9eda94ad-0b61-49d3-b7eb-d70704e81eda":{"description":"Authentication failed","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"API key is invalid.","type":"authentication_error","param":null,"code":"invalid_api_key"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"API key is invalid.","type":"authentication_error","param":null,"code":"invalid_api_key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ac2f1368-137a-4588-86c5-ddcc552d391b":{"description":"Resource not found","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"The requested resource was not found.","type":"not_found_error","param":null,"code":"resource_not_found"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The requested resource was not found.","type":"not_found_error","param":null,"code":"resource_not_found"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9766af40-f971-4ab7-8723-8046c3e9898b":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"API key authentication.\nKeys start with `ak_` prefix.\nExample: `Authorization: Bearer ak_live_xxxxxxxxxxxx`\n","scopes":[]}}},"servers":{"7a684522-107c-44d9-947d-4e0fc7defa27":{"url":"https://api.auriko.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication.\nKeys start with `ak_` prefix.\nExample: `Authorization: Bearer ak_live_xxxxxxxxxxxx`\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication.\nKeys start with `ak_` prefix.\nExample: `Authorization: Bearer ak_live_xxxxxxxxxxxx`\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"auriko","siteName":"Auriko","title":"Update API key - Auriko","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-26T03:54:20.883Z","originalFileLocation":"api-reference/update-api-key.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates an API key\u0026#x27;s mutable properties\">\u003cmeta data-mint-head name=\"application-name\" content=\"Auriko\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update API key - Auriko\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates an API key\u0026#x27;s mutable properties\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Auriko\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.auriko.ai/api-reference/update-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://auriko.mintlify.site/_mintlify/api/og/v2?division=API+Keys\u0026amp;title=Update+API+key\u0026amp;description=Updates+an+API+key%27s+mutable+properties\u0026amp;theme=6c346e3dbc150029ebd144bc\u0026amp;signature=802a90bc4dfcac4d654a3404b922f9309f06c317b470066784632f40a1ba1218\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update API key - Auriko\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates an API key\u0026#x27;s mutable properties\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://auriko.mintlify.site/_mintlify/api/og/v2?division=API+Keys\u0026amp;title=Update+API+key\u0026amp;description=Updates+an+API+key%27s+mutable+properties\u0026amp;theme=6c346e3dbc150029ebd144bc\u0026amp;signature=802a90bc4dfcac4d654a3404b922f9309f06c317b470066784632f40a1ba1218\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Auriko\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4779EA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.auriko.ai/api-reference/update-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/update-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.auriko.ai/#organization\",\"name\":\"Auriko\",\"url\":\"https://docs.auriko.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/auriko/ZctT69z8zlG3FLhm/logo/light.svg?fit=max\u0026auto=format\u0026n=ZctT69z8zlG3FLhm\u0026q=85\u0026s=9160396833137f89a62e6297d0da13e3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.auriko.ai#website\",\"name\":\"Auriko\",\"url\":\"https://docs.auriko.ai\",\"publisher\":{\"@id\":\"https://docs.auriko.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.auriko.ai/api-reference/update-api-key#webpage\",\"url\":\"https://docs.auriko.ai/api-reference/update-api-key\",\"name\":\"Update API key\",\"description\":\"Updates an API key's mutable properties\",\"dateModified\":\"2026-06-26T03:54:20.883Z\",\"isPartOf\":{\"@id\":\"https://docs.auriko.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.auriko.ai/api-reference/update-api-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.auriko.ai/api-reference/update-api-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.auriko.ai/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Keys\",\"item\":\"https://docs.auriko.ai/api-reference/list-api-keys\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update API key\",\"item\":\"https://docs.auriko.ai/api-reference/update-api-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.auriko.ai/api-reference/update-api-key#apireference\",\"headline\":\"Update API key\",\"name\":\"Update API key\",\"description\":\"Updates an API key's mutable properties\",\"url\":\"https://docs.auriko.ai/api-reference/update-api-key\",\"mainEntityOfPage\":{\"@id\":\"https://docs.auriko.ai/api-reference/update-api-key#webpage\"},\"dateModified\":\"2026-06-26T03:54:20.883Z\",\"publisher\":{\"@id\":\"https://docs.auriko.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.auriko.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Auriko\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Auriko\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/update-api-key.md","siteName":"Auriko","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"group":"Inference","pages":[{"title":"Create Chat Completion","openapi":"POST /v1/chat/completions","href":"/api-reference/chat-completions"},{"title":"Create response","openapi":"POST /v1/responses","href":"/api-reference/create-response"}]},{"group":"Models","pages":[{"title":"List callable models","openapi":"GET /v1/models","href":"/api-reference/list-callable-models"},{"title":"Retrieve callable model","openapi":"GET /v1/models/{model_id}","href":"/api-reference/retrieve-callable-model"}]},{"group":"Model Catalog","pages":[{"title":"Model directory","openapi":"GET /v1/directory/models","href":"/api-reference/model-directory"},{"title":"Canonical model records","openapi":"GET /v1/registry/models","href":"/api-reference/canonical-model-records"},{"title":"Provider catalog","openapi":"GET /v1/registry/providers","href":"/api-reference/provider-catalog"}]},{"group":"Account","pages":[{"title":"Get API key identity","openapi":"GET /v1/me","href":"/api-reference/get-api-key-identity"}]},{"group":"API Keys","pages":[{"title":"List API keys","openapi":"GET /v1/workspaces/{workspace_id}/api-keys","href":"/api-reference/list-api-keys"},{"title":"Get API key","openapi":"GET /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/get-api-key"},{"title":"Get API key usage","openapi":"GET /v1/workspaces/{workspace_id}/api-keys/{api_key_id}/usage","href":"/api-reference/get-api-key-usage"},{"title":"Create API key","description":"Creates a new API key in a workspace","openapi":"POST /v1/workspaces/{workspace_id}/api-keys","href":"/api-reference/create-api-key"},{"title":"Update API key","openapi":"PATCH /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/update-api-key"},{"title":"Revoke API key","description":"Revokes an API key","openapi":"DELETE /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/delete-api-key"}]},{"group":"BYOK","pages":[{"title":"List BYOK providers","openapi":"GET /v1/byok/providers","href":"/api-reference/list-byok-providers"},{"title":"List provider account tiers","openapi":"GET /v1/byok/providers/{provider}/tiers","href":"/api-reference/get-byok-provider-tiers"},{"title":"List BYOK keys","openapi":"GET /v1/workspaces/{workspace_id}/byok-keys","href":"/api-reference/list-byok-keys"},{"title":"Create BYOK key","openapi":"POST /v1/workspaces/{workspace_id}/byok-keys","href":"/api-reference/create-byok-key"},{"title":"Get BYOK key","openapi":"GET /v1/workspaces/{workspace_id}/byok-keys/{byok_key_id}","href":"/api-reference/get-byok-key"},{"title":"Update BYOK key","openapi":"PATCH /v1/workspaces/{workspace_id}/byok-keys/{byok_key_id}","href":"/api-reference/update-byok-key"},{"title":"Delete BYOK key","openapi":"DELETE /v1/workspaces/{workspace_id}/byok-keys/{byok_key_id}","href":"/api-reference/delete-byok-key"}]},{"group":"Billing","pages":[{"title":"Get credit balance","openapi":"GET /v1/workspaces/{workspace_id}/billing/balance","href":"/api-reference/get-credit-balance"}]}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/integration-guide"}]}]},"basePath":"","title":"Update API key - Auriko","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}