AIProviderKeyService
AI Provider Keys

List AI provider keys

Changed on

Lists all customer-provided AI provider keys in the workspace

get/v1/workspaces/{workspaceId}/ai_provider_keys

Request

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

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace whose keys will be listed.

Query parameters

limitinteger

Maximum number of results to return

cursorstring

Pagination cursor from previous response

prefixstring

Filter expression (query param: prefix)

querystring

Free-form search query

promotionalboolean

When true, return only promotional keys (provided by Cadenya, e.g. for onboarding). Defaults to returning all keys, customer-provided and promotional alike.

labelsstring

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

sortOrderstring

Sort order for results (asc or desc by creation time)

includeInfoboolean

When true, populate each item's info (model counts), at the cost of extra lookups.

Response

OK

Example response

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

Changes

  • 3ecc1debabfaRevision changes
    • 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 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 /////// response property for the response status

    • info

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

  • a99a473ee3adRevision changes
    • warning

      removed the optional property / from the response with the status