Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key (sig_...), or a session token from the web app.

Path Parameters

agentId
string<uuid>
required

The agent's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

runId
string<uuid>
required

The run's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

Query Parameters

compareTo
string<uuid>

Compare with this run instead of the previous comparable one.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

Response

The result document.

A run as one JSON document, the same one the CLI writes and webhooks post. Its field names are fixed by schemaVersion 1 and predate v1 naming: batchId is the run's id, and attempts[].runId is an attempt's id.

schemaVersion
enum<number>
required
Available options:
1
batchId
string
required

The run's id (runId on v1). The document keeps its schemaVersion 1 names because CI and webhooks already read them.

agentId
string
required
status
string
required

The run's status: queued, awaiting_approval, running, complete, refused or failed.

message
string | null
required
kind
string
required

run or calibration.

trigger
string | null
required
targetVersion
object
required
comparedTo
object | null
required
epoch
object | null
required

What scored a result. Results scored in different epochs are not compared.

summary
object
required
cost
object
required

Retell's share is the customer's spend; Signal's is ours to serve. Estimates.

cells
object[]
required
shadow
object

Present when the run played a shadow copy; the version is the one it was cloned from.