Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://origami.chat/api/v2/agents \
  --header 'Authorization: Bearer <token>'
{
  "agents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "apiKeyOwned": true,
      "lastRun": {
        "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"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "hasMore": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:0
Required range: x >= 0
​
pageSize
integer
default:50
Required range: 1 <= x <= 100

Response

A page of agents

​
agents
object[]
required
​
pagination
object
required

Standard pagination envelope used by every v2 list endpoint. Callers know to stop when hasMore === false; total is the unfiltered row count for the listing's scope.