Skip to main content
POST
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"

goalId
string<uuid>
required

The goal'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"

Body

application/json
inputTokens
integer
required
Required range: 0 <= x <= 1000000000
outputTokens
integer
required
Required range: 0 <= x <= 1000000000
model
string
Required string length: 1 - 120
cacheReadTokens
integer
Required range: 0 <= x <= 1000000000
cacheWriteTokens
integer
Required range: 0 <= x <= 1000000000
usd
number
Required range: 0 <= x <= 10000

Response

The goal's spend after the report.

goalId
string<uuid>
required
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"

title
string
required
status
string
required
model
object
required

Model tokens and dollars: the copilot's turns, quick checks, and what a client reported.

retell
object
required

The goal's Retell runs and their cost.

totalUsd
number
required