v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
ModelService
Models

List models

Lists all models in the workspace

get/v1/workspaces/{workspaceId}/models

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