Pagination parameters
| Parameter | Type | Default | Constraints |
|---|---|---|---|
page | integer | 1 | >= 1 |
size | integer | 10 | 1–1000 |
sort | list[string] | varies | Endpoint-specific fields, prefix - for descending |
The session event stream (
GET /sessions/{id}/events) is the one exception: it defaults size to 50 and caps it at 200.Response shape
Every paginated response has the same envelope:| Field | Type | Description |
|---|---|---|
items | array | The resources on this page. |
page | integer | Current page number. |
total | integer | Total number of matching resources across all pages. |
size you sent, so track it yourself. There are more pages while page * size < total.
Example: iterate through all sessions
Sorting
List endpoints support sorting via thesort parameter. Prefix with - for descending order.
Sessions
| Sort value | Description |
|---|---|
created_at | Oldest first. |
-created_at | Newest first (default). |
Agents
| Sort value | Description |
|---|---|
created_at / -created_at | By creation date. |
agent_name / -agent_name | Alphabetical by name. |
Skills
| Sort value | Description |
|---|---|
created_at / -created_at | By creation date. |
name / -name | Alphabetical by name. |
Filtering sessions
TheGET /api/v2/sessions endpoint supports several filters that can be combined:
| Filter | Type | Description |
|---|---|---|
status[] | string (multi-value) | Filter by session status (e.g., running, completed). |
agent[] | string (multi-value) | Filter by agent identifier (e.g., web-price-finder). |
group_id | string | Filter by group: useful for multi-session workflows. |
parent_session_id | string | Find child sessions of a parent. |
owner | string | Access scope. Default: me-in-organization. |
Example: find all running sessions for a specific agent
Example: find child sessions of a parent
Filtering skills
TheGET /api/v2/skills endpoint supports:
| Filter | Type | Description |
|---|---|---|
name | string | Name prefix filter. |