AIProviderKeyService
AI Provider Keys

Update an AI provider key

Changed on

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

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

Request

  • Base URL
    https://api.cadenya.com
  • URL
    https://api.cadenya.com/v1/workspaces/{workspaceId}/ai_provider_keys/{id}
  • Auth
    HTTP bearer

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"
  }
}

Changes

  • 3ecc1debabfaRevision changes
    • breaking

      the ///// request property type changed from object to no type

    • breaking

      the ///// request property type changed from object to no type

    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      the ///// response's property type changed from object to no type for status

    • breaking

      the ///// response's property type changed from object to no type for status

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added discriminator to ///// request property

    • info

      added discriminator to ///// request property

    • info

      added to the ///// request property oneOf list

    • info

      added to the ///// request property oneOf list

    • info

      added discriminator to ///// response property for the response status

    • info

      added discriminator to ///// response property for the response status

  • 06e0e37c1499Revision changes
    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new AI_PROVIDER_ANTHROPIC enum value to the / response property for the response status

    • warning

      added the new AI_PROVIDER_GEMINI enum value to the / response property for the response status

    • warning

      added the new AI_PROVIDER_OPENAI enum value to the / response property for the response status

    • warning

      added the new AI_PROVIDER_OPENAI_COMPATIBLE enum value to the / response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new AI_PROVIDER_ANTHROPIC enum value to the request property /

    • info

      added the new AI_PROVIDER_GEMINI enum value to the request property /

    • info

      added the new AI_PROVIDER_OPENAI enum value to the request property /

    • info

      added the new AI_PROVIDER_OPENAI_COMPATIBLE enum value to the request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status