Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).

Path Parameters

conversation_id
string<uuid>
required

the builder conversation's id, from build custom report.

Body

application/json
message_id
string<uuid>
required

the successful builder message whose draft to run.

controls
ReportControls · object | null

the inputs to change; omit to run the draft's own inputs.

Response

Successful Response

status
string
required

the run's outcome, such as succeeded or failed.

summary
any | null

the result's summary values.

detailed_data
any[] | null

the result's rows, every one the result holds.

total_rows
integer | null

rows in the result.

truncated
boolean | null

true when the response does not carry every row.

column_units
any | null

units per column.

row_label
any | null

what a row represents.

row_grain
any | null

the row grain.

presentation
any | null

presentation hints.

conversation_id
string | null

the builder conversation the draft belongs to.

message_id
string | null

the builder message that was run.

message
string | null

a note about the run.

effective_controls
any | null

the inputs the run actually used.

data_through
string | null

the last date the data covers.

url
string | null

the builder conversation in Edgeful AI.