Skip to main content
GET
/
v1
/
files
/
blueprints
/
{blueprint_id}
from retab import Retab

client = Retab()

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

print(blueprint.status)

{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a file blueprint by ID. 
from retab import Retab

client = Retab()

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

print(blueprint.status)

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
blueprint_id
string
required

Query Parameters

​
include_output
boolean
default:true

When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.

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"
​
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.

​
created_at
string<date-time> | null
​
started_at
string<date-time> | null
​
completed_at
string<date-time> | null