Action API
POST/listAgentsAPI v2

List agents

2 min readAgentsView as Markdown

POST /listAgents

List agents

Base URL: https://www.taskade.com/api/v2

Authentication

Send a personal access token or an OAuth 2.0 access token as a bearer token. Create a personal access token at taskade.com/settings/api.

Http
Authorization: Bearer tskdp_your_token_here

Request body

application/json

Field Type Required Description
spaceId string Yes The space ID to list agents for
filterBy object No —
filterBy.name object No —
filterBy.name.operator string Yes Allowed values: contains, equals.
filterBy.name.value string Yes —

A nested field marked Yes is required whenever its parent object is present.

Example request

Bash
curl -X POST "https://www.taskade.com/api/v2/listAgents" \
  -H "Authorization: Bearer $TASKADE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"<spaceId>"}'

Responses

200 — Default response

Field Type Required Description
ok boolean Yes —
items object[] Yes —
items[].id string Yes —
items[].name string Yes —
items[].description string Yes —
items[].tools object Yes —

Errors

Errors return an ok: false envelope. Rate limiting returns 429 with x-rate-limit-limit, x-rate-limit-remaining and x-rate-limit-reset headers. x-rate-limit-reset is the number of seconds until the window reopens. Retry-After is not sent, so schedule retries from x-rate-limit-reset; retrying sooner will fail again.

Json
{ "ok": false, "message": "Unauthorized", "code": "UNAUTHORIZED" }

Rate limits for this version: enforced per endpoint; ceilings are not published and can change without notice. A 429 response carries x-rate-limit-limit, x-rate-limit-remaining, and x-rate-limit-reset (seconds until the window reopens). Back off from those headers rather than hardcoding numbers. If you need sustained throughput, prefer batching (operations like /createTask accept arrays) over tightening polling loops. See Rate limits.