Skip to navigation
Workspace APIWorkspace Agents

List the org agent directory

View as Markdown

Lists the paperwork agents this organization owns, one keyset page at a time, newest-updated first. Authorization: any authenticated org member (session + tenant context only, no admin required). Optional query status is one of all | published | draft (default all); any other value is ignored and the default applies. Optional includeArchived=true adds archived agents. A private agent is listed only for its owner; it is absent from every other member’s directory. Paging: limit is 1-200 (default 100), and cursor takes the previous response’s nextCursor — an opaque string the caller never parses; an out-of-range or non-numeric limit falls back to the default instead of failing. Response is { data: Agent[], nextCursor } and nextCursor is null on the last page. Each Agent carries its id, handle, name, role, avatar, visibility, publishedVersionId (the agv_ id runs are started with), draftVersionId and sourcePlaybookId.

Authentication

AuthorizationBearer

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

Query parameters

statusenumOptionalDefaults to all
Filter by lifecycle state.
Allowed values:
includeArchivedenumOptionalDefaults to false
Include archived agents.
Allowed values:
limitintegerOptional1-200Defaults to 100
Agents per page.
cursorstringOptional

The previous page’s nextCursor.

Response

One page of org agents.
datalist of objects
nextCursorstring or null

Pass back as cursor for the next page — opaque, never parsed. Null on the last page.