Skip to main content
POST
Price a structured European capability

Authorizations

Authorization
string
header
required

An organisation API key: Authorization: Bearer apk_org_live_…

Body

application/json
capability
enum<string>
required
Available options:
eu.company.profile,
eu.tenders.search,
eu.statistics.query
country
string

Optional two-letter ISO country code used for source routing.

Pattern: ^[A-Za-z]{2}$
input
object

Structured fact-type input; inspect resolve for exact field schemas.

operation
string

Optional exact operation selector, required for CBS observation metrics.

Response

Saved plan for review and explicit approval.

id
string<uuid>
status
enum<string>
Available options:
requires_approval,
running,
completed,
partial,
needs_input,
needs_selection,
unsupported,
cancelled,
failed
question
string
capability
string

European capability slug for a structured capability plan or run.

normalized_records
object[]

Contract-extracted provider facts grouped by subject. Equal facts for one subject are combined with all their source references; absent fields are never invented.

plan
object
answer
object | null

Apiosk's reading of the results, with evidence pointers. Null for a direct call.

data
object

The source document, when the run produced exactly one.

results
object[]
usage
object
balance
object
errors
object[]
retry_after_ms
integer
message
string | null

Natural-language clarification for needs_input.

needs_input
object[]
candidates
object[] | null
approval_required_reason
object
metadata
object

Attribution for a single result, when present.

continuation
object