Skip to main content
POST
documents.remove

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: a step of this outcome has an external effect. A retry with the same key repeats no step that already acted.

Maximum string length: 255
Pramaan-Plan
string

The plan a person approved, from the estimate. Required when a step of the plan needs approval. A request that makes a different plan (another input, option, step, price, organisation or member), or a plan more than 15 minutes old, is refused with conflict.

Body

application/json
input
object
required
options
object

No options: every run reads the ids and removes what it found.

basis
object

Optional: your stated lawful basis. Recorded on the run, not checked and never required.

Response

The run report

outcome
string
required
version
integer
required
plan
string
required

The plan that ran, as the estimate names it.

status
enum<string>
required

done: result is present. failed: a required step failed; read steps for what ran.

Available options:
done,
failed,
declined
evidence
object
required

Per result field: how sure, why, and which steps said so.

missing
object[]
required

Result fields that are absent, each with the reason.

steps
object[]
required

Every step, in order: what ran and what it did.

cost
object
required
completeness
enum<string>
Available options:
complete,
partial
result
object
usage
object
basis
object
error
object

With failed or declined: the step that stopped the run and its error.