List agents
Every agent in the workspace, filterable by state. Archived ones are hidden until you ask.
Archived agents are hidden by default
The list returnsSTATE_DRAFT and STATE_PUBLISHED agents and leaves archived ones out. To see archived agents, ask for them by state:
state filter narrows to one state, and there are three you can pass:
state: 'STATE_ARCHIVED' is the only way to list archived agents, and state: 'STATE_DRAFT' is how you find the agents that still need a variation before they can publish.
info comes for free
Each row carries info on every call, includeInfo is a no-op here:
variationCount is the quick way to spot an agent that cannot run yet: a published agent needs at least one variation, and a 0 on a draft is why it cannot publish.
Paging and filtering
The usual list controls apply:limit (1 to 100), cursor, prefix (name starts-with), and query (free-text over name and description). A pagination block with a nextCursor comes back while more pages remain, and is absent on the last page.
Related
Get an agent
external_id:.Create an agent
STATE_DRAFT agent starts as.Publish an agent
STATE_PUBLISHED so it can run.List variations
info.variationCount.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Query Parameters
Maximum number of results to return
Pagination cursor from previous response
Filter expression (query param: prefix)
Free-form search query
Filter by agent lifecycle state
STATE_UNSPECIFIED, STATE_DRAFT, STATE_PUBLISHED, STATE_ARCHIVED Filter by variation selection mode
VARIATION_SELECTION_MODE_UNSPECIFIED, VARIATION_SELECTION_MODE_RANDOM, VARIATION_SELECTION_MODE_WEIGHTED 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).
Sort order for results (asc or desc by creation time)
When true, the info field on each returned agent is populated. Requests
with this flag count more against your rate limit.