Skip to main content
GET
/
api
/
v1
/
agent-executions
List Agent Executions
curl --request GET \
  --url https://api.example.com/api/v1/agent-executions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "agentId": "<string>",
      "workspaceId": "<string>",
      "state": {
        "status": "PENDING_INPUTS"
      },
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": false,
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
agent_execution_id
string<uuid4>[] | null
​
agent_id
string<uuid4>[] | null
​
workspace_id
string<uuid4>[] | null
​
status
enum<string>[] | null
Available options:
PENDING_INPUTS,
PENDING_DATA_EXTRACTION,
PENDING_REVIEW,
CANCELED,
CONFIRMED,
DELIVERED_TO_DESTINATION
​
skip
integer
default:0
Required range: x >= 0
​
limit
integer
default:100
Required range: 1 <= x <= 100
​
expand
string[] | null

total_count: Include the total number of agent executions that match the query, only accurate up to 100.

Allowed value: "total_count"

Response

Successful Response

​
data
AgentExecution · object[]
required
​
hasMore
boolean
default:false

Whether there are more agent executions that match the query that were not included in this response.

​
totalCount
integer | null

The total number of agent executions that match the query, only accurate up to 100.