Skip to main content
POST
The plan for one input, without running it

Authorizations

Authorization
string
header
required

API key: sk_live_…

Path Parameters

id
string
required

Body

application/json

The body is of type object.

Response

The plan

outcome
string
required
version
integer
required
plan
string
required

Names this input, these options, these steps and their prices, for this organisation and member. Good for 15 minutes.

ready
boolean
required

false while an input or connection need is open.

can_run
boolean
required
price_min_micro
integer
required

The least a run that finishes its required steps costs, micro-USD: a required step whose request is known when the plan is made counts at what its cheapest source asks, any other required step at its limit.

price_max_micro
integer
required

What a run sets aside, micro-USD.

balance_micro
integer
required
seconds
object
required
requires_approval
boolean
required
steps
object[]
required
needs
object[]
required
connect_url
string

Link to the dashboard connection picker when an account is missing.

message
string

Why a read-only key cannot run this work.

reason
enum<string>
Available options:
balance,
daily_cap,
member_limit,
connection_required,
read_only
price_typical_micro
integer

Sum of active steps' capability medians times their planned maximum call counts, each capped at its step's bound, then kept between price_min_micro and price_max_micro. Each paid step needs at least 20 successful paid calls among its last 200 within 30 days across all callers; otherwise omitted. Cached for 5 minutes. Historical guidance only; does not change the hold.