List Suite Runs

Beta

GET

https://api.speechify.ai/v1/agents/tests/suite-runs

GET

/v1/agents/tests/suite-runs

$ curl https://api.speechify.ai/v1/agents/tests/suite-runs \
>      -H "Authorization: Bearer <token>"

1 {
2   "next_cursor": "string",
3   "has_more": true,
4   "suite_runs": [
5     {
6       "id": "srun_01kpvdq02cbtxqqsca60m5scng",
7       "trigger": "run_all",
8       "status": "pending",
9       "total": 1,
10       "completed": 1,
11       "failed": 1,
12       "running": 1,
13       "pending": 1,
14       "cancelled": 1,
15       "results": {
16         "passed": 1,
17         "failed": 1
18       },
19       "created_at": "2024-01-15T09:30:00Z",
20       "agent_id": "agent_01jqr8x9zg5k2m3n4p5q6r7s8t",
21       "agent_name": "string",
22       "parent_suite_run_id": "string",
23       "verdict": "passed",
24       "ended_at": "2024-01-15T09:30:00Z",
25       "config_override": {
26         "prompt": "string",
27         "model": "string",
28         "tool_ids": [
29           "string"
30         ]
31       },
32       "flow_version_id": "fver_01arz3ndektsv4rrffq69g5fav",
33       "flow_version_number": 1
34     }
35   ]
36 }

List one page of suite runs (test invocations), newest first. A suite run groups every test run dispatched by one Run All, batch, or resubmit call. Paginate by passing cursor from the previous response.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Query parameters

agent_idstringOptional

Narrow the list to the suite runs of one agent.

cursorstringOptional

Opaque pagination cursor from a previous response.

limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

One page of suite runs.

next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean

True when more rows exist beyond this page.

suite_runslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

Authentication

Headers

Query parameters

Response headers

Response

Errors