ModelService
Models

List models

Changed on

Lists all models in the workspace

get/v1/workspaces/{workspaceId}/models

Request

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

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

Query parameters

limitinteger

Maximum number of results to return

cursorstring

Pagination cursor from previous response

prefixstring

Filter by a prefix of the model's display name, external id, or id (case-insensitive). A model's external id is the form used in modelConfig.modelId, so a caller holding that can narrow the list by it.

querystring

Free-form search query

state'STATE_UNSPECIFIED' | 'STATE_ENABLED' | 'STATE_DISABLED' enum

Filter by model state

aiProviderKeyIdstring

Filter to models provisioned on a specific AI provider key. Accepts the key's id or an "external_id:"-prefixed slug.

isAssignedboolean

Filter models to only ones assigned to an active agent variation/agent. Draft agents count as assigned; archived agents do not. Assignment does not imply recent traffic — see ModelInfo.last_used_at for that.

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 (e.g. the AI provider), at the cost of extra lookups.

Response

OK

Changes

  • ac1a7f084068Revision changes
    • info

      added the optional property /////// to the response with the status

  • 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

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

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

    • info

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