Skip to main content

List tasks — GET /v3/bots/runs

Returns a paginated list of Bot execution tasks. ### Filtering - Use `status` to filter by task status. - Use `bot_id` to list tasks created from a specific Bot. - Use `bot_name` to search by Bot name using a contains match. - Use `created_at_from` / `cr

Written by Maggie

GET /v3/bots/runs

Returns a paginated list of Bot execution tasks.### Filtering - Use `status` to filter by task status. - Use `bot_id` to list tasks created from a specific Bot. - Use `bot_name` to search by Bot name using a contains match. - Use `created_at_from` / `created_at_to` for inclusive task creation time bounds in ISO 8601 format.### Pagination Use `page` and `limit`. The response includes `total_pages` and `total_count`.Normal Bot runs can include `bot_id` and `bot_name`. Official template runs omit template source fields and internal copied Bot IDs.

Authentication

HTTPBearer

Parameters

  • bot_id (query, string, optional) — Optional public bot identifier filter.

  • bot_name (query, string, optional) — Optional bot name keyword (fuzzy match, contains).

  • status (query, string, optional) — Filter tasks by status.

  • created_at_from (query, string, optional) — Lower bound of task creation time (inclusive). ISO 8601 format, e.g. `2024-01-01T00:00:00Z`.

  • created_at_to (query, string, optional) — Upper bound of task creation time (inclusive). ISO 8601 format, e.g. `2024-12-31T23:59:59Z`.

  • page (query, integer, optional) — Page number to retrieve (starts at 1).

  • limit (query, integer, optional) — Number of tasks per page (max 100).

Responses

200 — Runs returned.

{  "items": [    {      "task_id": "string",      "bot_id": "string",      "bot_type": "workflow",      "bot_name": "string",      "status": "created",      "created_at": "2026-01-01T00:00:00Z",      "finished_at": "2026-01-01T00:00:00Z",      "input": {},      "task_failure_info": {        "code": 0,        "message": "string"      },      "live_url_info": {        "live_url": "string",        "width": 0,        "height": 0      },      "credit": 0    }  ],  "page": 0,  "limit": 0,  "total_count": 0,  "total_pages": 0}

400 — Bad Request

{  "code": 123,  "msg": "Invalid task_id",  "data": null,  "ts": 1786634400000,  "time": "2026-08-13 18:00:00",  "traceId": "a1b2c3d4e5f6"}

500 — Internal Server Error

{  "code": 123,  "msg": "Invalid task_id",  "data": null,  "ts": 1786634400000,  "time": "2026-08-13 18:00:00",  "traceId": "a1b2c3d4e5f6"}

Did this answer your question?