v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
AIProviderKeyService
AI Provider Keys

Update an AI provider key

Updates an AI provider key's name or key value in the workspace

patch/v1/workspaces/{workspaceId}/ai_provider_keys/{id}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace the key belongs to.

idstring required
Example:aipk_01HXKD2E5NQM3T9AYWCFQ41VW3

The key to update.

Request body

workspaceIdstring

The workspace the key belongs to.

idstring

The key to update.

updateMaskstring field-mask

Fields to update.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "id": "aipk_01HXKD2E5NQM3T9AYWCFQ41VW3"
}

Response

OK

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  }
}