Skip to main content
GET
/
agents
List agents (cursor-paginated; ?search=)
curl --request GET \
  --url https://origami.chat/api/v2/agents \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "items": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "apiKeyOwned": true,
      "lastRun": {
        "object": "<string>",
        "id": "<string>",
        "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prompt": "<string>",
        "steps": {
          "completed": 1,
          "max": 2
        },
        "startedAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "nextCursor": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string

Opaque pagination cursor. Pass the nextCursor from the previous page to fetch the next one; omit for the first page.

​
limit
integer
default:50

Max objects to return per page. Default 50, max 100 (the rows endpoint allows up to 200 and documents its own limit).

Required range: 1 <= x <= 100
​
search
string

Case-insensitive substring match on the agent name.

Response

A page of agents in the canonical list envelope.

The canonical v2 list envelope. Every list endpoint returns this shape; per-endpoint items element types (and documented extras like total) are declared on each operation.

​
object
string
required
Allowed value: "list"
​
items
object[]
required

The page of objects. Element type is per-endpoint.

​
nextCursor
string | null
required

Cursor for the next page; null means this is the last page.

​
url
string
required

The path this list was fetched from (query string excluded).