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>).

Body

application/json
brief
string
required

the analysis to build, in plain language. never code.

Required string length: 1 - 25000
ticker
string | null

the ticker to build the report on.

Required string length: 1 - 30
market_type
enum<string> | null

the market the ticker trades in.

Available options:
futures,
stock,
forex,
crypto
session

a standard session name, or a custom window.

Required string length: 1 - 80

Response

Successful Response

status
string
required

succeeded with a draft to review, needs_clarification with a question to answer, or failed.

conversation_id
string | null

the builder conversation: send it to revise, run or save this draft.

message_id
string | null

the builder message: with status succeeded, the draft to run or save.

url
string | null

the builder conversation in Edgeful AI.

question
string | null

with status needs_clarification: the question to answer in a revision.

message
string | null

with status failed: what went wrong.

methodology
any | null

how the report computes its result.

assumptions
any | null

the assumptions the builder made.

accepted_controls
any | null

the inputs the draft was built on: market, ticker, session, dates and granularity.

sample_result
CustomReportRows · object | null

the draft's result over the builder's sample window.

truncated
boolean | null

true when a long question was shortened.