a13nDocs
API referenceAgents

List Agents

Agents of the workspace. `q` matches the name or description, ignoring case; `archived` keeps only archived agents, or only open ones; `source=builtin` finds the Agent Composer; the skill filters keep those with a revision pinning that skill or that skill revision.

GET/api/v1/agents

Agents of the workspace. q matches the name or description, ignoring case; archived keeps only archived agents, or only open ones; source=builtin finds the Agent Composer; the skill filters keep those with a revision pinning that skill or that skill revision.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Query Parameters

label?array<string>|null
q?|null
archived?boolean|null
source?|null
skill_id?|null
skill_revision_id?|null
limit?Limit
Range1 <= value <= 100
Default50
cursor?string|null

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/agents"
{  "items": [    {      "archived_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "created_by_id": "string",      "default_revision_id": "string",      "description": "string",      "id": "string",      "image_url": "string",      "labels": {        "property1": "string",        "property2": "string"      },      "name": "string",      "organization_id": "string",      "source": "custom",      "updated_at": "2019-08-24T14:15:22Z",      "updated_by_id": "string",      "version": 0,      "workspace_id": "string"    }  ],  "next_cursor": "string"}