Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
model
enum<string>

Business Model

Available options:
ecommerce,
saas
avgOrderValue
number

Avg Order Value ($)

Required range: x >= 0
purchaseFrequency
number

Purchases / Year

Required range: x >= 0
customerLifespan
number

Customer Lifespan (years)

Required range: x >= 0
grossMargin
number

Gross Margin (%)

Required range: 0 <= x <= 100
arpu
number

ARPU / Month ($)

Required range: x >= 0
churnRate
number

Monthly Churn (%)

Required range: 0 <= x <= 100
saasMargin
number

Gross Margin (%)

Required range: 0 <= x <= 100
cac
number

CAC / Customer ($)

Required range: x >= 0

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.