Skip to main content
POST
cURL
Prepare a risk package, evidence set or billing report for download. Each kind requires its own source permissions in addition to export access. All IDs and cursors must belong to the authorized workspace and environment. Required scope: exports:write. Data exports require data:read and source authorization; risk-package exports require results:read; billing exports require billing:read and Owner authority; evidence exports require evidence:read and source entitlements. Permissions are checked at creation, retrieval and download. Examples use synthetic IDs. Replace them with values returned by your environment.

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Headers

Idempotency-Key
string
required

Stable for one intended command and its retries, scoped to key workspace/environment and operation. Mismatched body returns 409. Full response replay 24 hours; durable receipt remains.

Minimum string length: 1

Body

application/json
kind
enum<string>
required

Kind for CreateExport. Constraints, requiredness and allowed values are defined by this schema.

Available options:
risk_package,
evidence,
billing,
data
Allowed value: "risk_package"
format
enum<string>
required

Format for CreateExport. Constraints, requiredness and allowed values are defined by this schema.

Available options:
json,
pdf
risk_package_id
string
required

Opaque identifier, authorized within the API key workspace and environment.

Minimum string length: 1
evidence_set_id
string

Opaque identifier, authorized within the API key workspace and environment.

Minimum string length: 1
billing_report_type
enum<string>

Billing report type for CreateExport. Constraints, requiredness and allowed values are defined by this schema.

Available options:
usage,
credits,
statements,
funding,
rates,
workload
window
object

Window for CreateExport. Constraints, requiredness and allowed values are defined by this schema.

data_snapshot_id
string

Opaque ID within the authorized workspace and environment.

Minimum string length: 1

Response

Accepted asynchronously; inspect status, not just HTTP success.

data
object
required
meta
object
required