Skip to main content
GET
/
states
List States
curl --request GET \
  --url https://api.example.com/states
[
  {
    "agent_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "state": {},
    "task_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Query Parameters

​
task_id
string | null

Task ID

​
agent_id
string | null

Agent ID

​
limit
integer
default:50

Limit

Required range: x >= 1
​
page_number
integer
default:1

Page number

Required range: x >= 1
​
order_by
string | null

Field to order by

​
order_direction
string
default:desc

Order direction (asc or desc)

Response

Successful Response

​
agent_id
string
required
​
created_at
string<date-time>
required

The timestamp when the state was created

​
id
string
required

The task state's unique id

​
state
The state to send to the task. · object
required
​
task_id
string
required
​
updated_at
string<date-time> | null

The timestamp when the state was last updated