AIProviderKeyService
AI Provider Keys

List AI provider keys

Lists all customer-provided AI provider keys in the workspace

get/v1/workspaces/{workspaceId}/ai_provider_keys

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

Changed in 8 of the 57 revisions of this API.41612

  • 3ecc1debabfa452See 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

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

      response-optional-property-removed

    • added the new optional query request parameter labels

      new-optional-request-parameter

    • 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

    • added the new optional query request parameter promotional

      new-optional-request-parameter

    • 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 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • 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 new optional query request parameter includeInfo

      new-optional-request-parameter

    • 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

    • endpoint added

      endpoint-added