Skip to content

Estimate Run

GET
/api/workbooks/{workbook_id}/run/estimate
curl --request GET \
--url http://localhost:8000/api/workbooks/example/run/estimate \
--header 'Authorization: Bearer <token>'

Estimate the spend of running this workbook BEFORE running it.

Returns worst/best USD + a per-column breakdown of paid providers, so the UI can show a spend-confirmation gate (“N rows × providers = $X, proceed?”).

workbook_id
required
Workbook Id
string
x-workspace-id
Any of:
string

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}