Skip to main content
GET
CLI

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

Query Parameters

limit
integer<int32>

Maximum number of results to return

cursor
string

Pagination cursor from previous response

prefix
string

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.

query
string

Free-form search query

state
enum<string>

Filter by model state

Available options:
STATE_UNSPECIFIED,
STATE_ENABLED,
STATE_DISABLED
aiProviderKeyId
string

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

isAssigned
boolean

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.

labels
string

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).

sortOrder
string

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

includeInfo
boolean

When true, populate each item's info (e.g. the AI provider), at the cost of extra lookups.

Response

OK

List models response

items
object[]
required
pagination
object

Page carries cursor-based pagination state. There is no total: the cursor walks the result set without ever counting it, and a count would cost a second query on every list.