Cancel File Blueprint

Cancel an in-flight background file blueprint.

POST /v1/files/blueprints/{blueprint_id}/cancel

Python

from retab import Retab

client = Retab()

blueprint = client.files.create_blueprint_cancel("fbp_a1b2c3d4e5f6")

print(blueprint.status)

200

{
  "id": "<string>",
  "file": {
    "id": "<string>",
    "filename": "<string>",
    "mime_type": "<string>"
  },
  "object": "file.blueprint",
  "intent": "<string>",
  "output": {},
  "status": "pending",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Cancel an in-flight background file blueprint.

Python

from retab import Retab

client = Retab()

blueprint = client.files.create_blueprint_cancel("fbp_a1b2c3d4e5f6")

print(blueprint.status)

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

200

application/json

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.

Show child attributes

object · string · default: file.blueprint

Allowed value: "file.blueprint"

mode · enum<string> | null

Analysis depth used or requested.

Available options: instant, reasoning

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

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

Show child attributes

created_at · string<date-time> | null

started_at · string<date-time> | null

completed_at · string<date-time> | null