SpecifyDocs

Agent roster

/v1/work/agent-roster

Signed-in sessionLaunch key product.workOperation agent_roster

People follow what their agents are doing: open sessions, progress events, and the finished sessions that need a person to check them.

Query parameters

expectedAuthorizationVersionstring

Returns

contextobjectRequired
freshnessobjectRequired
permission"not_permitted" | "permitted"Required
agentsnull | object[]Required
groupsnull | object[]Required
runningobjectRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}. A call without a valid credential gets 401 before its input is checked, and so does an address that is not an operation: 404 and 400 come only once the credential is accepted. Public operations answer without one.