Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://api.push.ai/api/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "agents": [
    {
      "id": 123,
      "name": "<string>",
      "parameters": [
        {
          "name": "<string>",
          "required": true,
          "description": "<string>"
        }
      ],
      "description": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

x-api-key
string
header
required

Organization API key. Create one in the Push AI dashboard under Settings → API Keys.

Query Parameters

limit
integer
default:20

Maximum number of agents to return (1–100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of agents to skip for pagination.

Required range: x >= 0

Response

A paginated list of published agents.

agents
object[]
required
pagination
object
required