v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-275867561.6 MB
agents

List agents

Returns the agents the authenticated user has access to. The default audience=user view returns the agents the caller owns plus any agents that have been directly shared with the caller via permissions.shared_users. The alternate audience=tenant view returns only the workspace-shared agents (those whose permissions.visibility is tenant). System-created defaults are always excluded.

Each item carries two caller-relative fields that describe the authenticated user's relationship to that agent:

  • is_ownertrue if the caller is the agent's owner.
  • access_level — one of READ, RUN, or WRITE. Owners get WRITE. Direct shares get the level matching the shared_users list they appear in. Tenant-shared rows get the agent's tenant_access_level. The maximum applicable level always wins.

Results are cursor-paginated. Pass the cursor value from the previous response to fetch the next page; next_cursor is omitted when no further pages exist.

get/v1/fleet/agents

Query parameters

page_sizeinteger

Items per page (1-100). Default 20.

cursorstring

Opaque pagination cursor returned by the previous list call.

namestring

Case-insensitive substring filter on the agent name.

audience'user' | 'tenant'

Scope of agents to return. user (default) returns owned + directly-shared. tenant returns workspace-shared only.

sort_by'created_at' | 'updated_at' | 'name'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

Response

OK

next_cursorstring

Example response

{
  "items": [
    {
      "backend": {
        "sandbox": {
          "delete_after_stop_seconds": 1200,
          "idle_ttl_seconds": 600,
          "snapshot_id": "550e8400-e29b-41d4-a716-446655440000"
        },
        "type": "thread_scoped_sandbox"
      },
      "runtime": {
        "model": {
          "model_id": "claude-sonnet-4-6"
        }
      }
    }
  ]
}