Skip to content

Delete one run's result

DELETE
/v1/runs/{reference}
curl --request DELETE \
--url https://example.com/v1/runs/example \
--header 'Authorization: Bearer <token>'

Clear what was extracted, and keep the record that it was.

The reference is the one the listing gives you: a job id for a single document, a batch id for anything that came out of a folder. Deleting a batched document clears the whole batch, which is the honest reading of a reference that names the batch rather than the item.

A reference this account does not own answers 404, the same as one that never existed, so a guessed id cannot confirm somebody else’s run.

reference
required
Reference
string

Successful Response

Media typeapplication/json
DeleteRunsResponse

What a delete actually removed.

cleared counts result bodies, not runs: deleting a batch clears every document inside it, so one reference can answer with fifty. The rows themselves stay, which is why the listing keeps showing what ran.

object
cleared
required
Cleared

Result bodies removed. Zero means there was none left.

integer
placements
Placements

Tract positions forgotten with them. A placement whose geometry is gone points at nothing, so it goes too.

integer
0
Example
{
"cleared": 1,
"placements": 2
}

Missing, unknown, or revoked API key

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
"error": {
"documents_used": 200,
"message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
"monthly_cap": 200,
"resets_on": "2026-08-01",
"type": "quota_exceeded"
}
}

No such resource under this caller

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
"error": {
"documents_used": 200,
"message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
"monthly_cap": 200,
"resets_on": "2026-08-01",
"type": "quota_exceeded"
}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}

Extraction temporarily unavailable

Media typeapplication/json
ErrorResponse
object
error
required
ErrorDetail
object
type
required
Type
string
message
required
Message
string
key
additional properties
any
Example
{
"error": {
"documents_used": 200,
"message": "Monthly document quota reached: 200 of 200 documents used this month. The cap resets on 2026-08-01. Email sales@easting.ai to raise it.",
"monthly_cap": 200,
"resets_on": "2026-08-01",
"type": "quota_exceeded"
}
}