Get an AI provider key by ID

Retrieves an AI provider key by ID from the workspace

get/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 retrieve.

Response

Example response

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

Changes

Changed in 6 of the 57 revisions of this API.4159

Jul 19, 20263ecc1debabfa452See the full diff
- ▲
  added to the ///// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the ///// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the ///// response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ○
  added discriminator to ///// response property for the response status
  response-property-discriminator-added
- ○
  added discriminator to ///// response property for the response status
  response-property-discriminator-added
Jul 2, 202606e0e37c149972See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new AI_PROVIDER_ANTHROPIC enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_GEMINI enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_OPENAI enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_OPENAI_COMPATIBLE enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 12, 2026ea07a25ab5da1See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Jun 9, 202613d98d37dd961See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 7, 2026873a704256d932See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new AI_PROVIDER_OPENROUTER enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_UNSPECIFIED enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jun 7, 2026902986a268db1See the full diff
- ○
  endpoint added
  endpoint-added

Full history