Skip to main content
GET
/
v1
/
parses
/
{parse_id}
from retab import Retab

client = Retab()

parse = client.parses.get("parse_01G34H8J2K")
print(parse.output.text)
print(parse.file.filename)

{
  "id": "parse_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "document.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "table_parsing_format": "markdown",
  "image_resolution_dpi": 192,
  "output": {
    "pages": [
      "# Document Title\n\nFirst page content...",
      "Second page content..."
    ],
    "text": "# Document Title\n\nFirst page content...\n\nSecond page content..."
  },
  "usage": {
    "page_count": 2,
    "credits": 1.0
  },
  "created_at": "2024-03-15T10:30:00Z"
}

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 single persisted parse by ID. 
from retab import Retab

client = Retab()

parse = client.parses.get("parse_01G34H8J2K")
print(parse.output.text)
print(parse.file.filename)

{
  "id": "parse_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "document.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "table_parsing_format": "markdown",
  "image_resolution_dpi": 192,
  "output": {
    "pages": [
      "# Document Title\n\nFirst page content...",
      "Second page content..."
    ],
    "text": "# Document Title\n\nFirst page content...\n\nSecond page content..."
  },
  "usage": {
    "page_count": 2,
    "credits": 1.0
  },
  "created_at": "2024-03-15T10:30:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
parse_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 parse result: the per-page and full-document text extracted from a document.

​
id
string
required

Unique identifier of the parse

​
file
FileRef · object
required

Information about the parsed file

​
model
string
required

Model used for parsing

​
table_parsing_format
enum<string>
required

Format used to render tables extracted from the document

Available options:
markdown,
yaml,
html,
json
​
image_resolution_dpi
integer
required

DPI used when rasterizing pages for the parser

​
output
ParseOutput · object
required

The parsed document content

​
instructions
string | null

Free-form instructions supplied with the parse request.

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

​
usage
RetabUsage · object

Usage information for the parse operation

​
created_at
string<date-time> | null