Skip to main content
GET
Describe one outcome: its schemas and the capability steps it may run

Authorizations

Authorization
string
header
required

API key: sk_live_…

Path Parameters

id
string
required

Response

The outcome

id
string
required
description
string
required
version
integer
required
effect_class
string
required

The highest effect class among the steps it may run.

mode
enum<string>
required

async: the run answers 202 with a job; poll GET /v1/jobs/{id}.

Available options:
sync,
async
price_max_micro
integer
required

The most a run can cost with every step on, micro-USD.

personal_data
boolean
required

true: a step looks up, scores or contacts a person.

available
boolean
required

false: a step's capability is not served yet.

input_schema
object
required
options_schema
object
required
result_schema
object
required
steps
object[]
required
read_only_key
boolean

True when the calling key may only run read_only capabilities.

requires_approval
enum<boolean>

Present when a step asks a person to approve: a run then needs Pramaan-Plan.

Available options:
true
capability_ids
string[]

Capability ids in mission step order.