Skip to main content
POST
Cancel an in-flight background file blueprint.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

blueprint_id
string
required

Response

Successful Response

A document blueprint generated from an uploaded file.

id
string
required

Unique identifier of the file blueprint.

file
FileRef · object
required

Information about the analyzed file.

object
string
default:file.blueprint
Allowed value: "file.blueprint"
intent
string | null

User intent supplied with the blueprint request.

output
Output · object

The generated Document Blueprint payload.

status
enum<string>
default:pending

Lifecycle status. The synchronous path returns 'completed'. Background runs progress pending -> queued -> in_progress -> completed | failed | cancelled.

Available options:
pending,
queued,
in_progress,
completed,
failed,
cancelled
error
PrimitiveError · object | null

Error details when a background run fails; null otherwise. Always present so consumers can read it without an existence check.

created_at
string<date-time> | null
started_at
string<date-time> | null
completed_at
string<date-time> | null
mode
enum<string> | null
Available options:
instant,
reasoning