Skip to main content
GET
/
v1
/
edits
/
{edit_id}
from retab import Retab

client = Retab()
edit = client.edits.get("edit_01G34H8J2K")
print(edit.data.form_data)

{
  "id": "edit_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "form.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "instructions": "Name: John Doe",
  "template_id": null,
  "config": {"color": "#000080"},
  "data": {
    "form_data": [
      {"key": "full_name", "type": "text", "value": "John Doe", "description": "Full name", "bbox": {"left": 0.15, "top": 0.20, "width": 0.35, "height": 0.03, "page": 1}}
    ],
    "filled_document": {"filename": "form_filled.pdf", "url": "data:application/pdf;base64,..."}
  },
  "usage": {"page_count": 1, "credits": 1.0},
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T10:30:00Z"
}

from retab import Retab

client = Retab()
edit = client.edits.get("edit_01G34H8J2K")
print(edit.data.form_data)

{
  "id": "edit_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "form.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "instructions": "Name: John Doe",
  "template_id": null,
  "config": {"color": "#000080"},
  "data": {
    "form_data": [
      {"key": "full_name", "type": "text", "value": "John Doe", "description": "Full name", "bbox": {"left": 0.15, "top": 0.20, "width": 0.35, "height": 0.03, "page": 1}}
    ],
    "filled_document": {"filename": "form_filled.pdf", "url": "data:application/pdf;base64,..."}
  },
  "usage": {"page_count": 1, "credits": 1.0},
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T10:30:00Z"
}

​
Path Parameters

​
edit_id
string
required
The unique identifier of the edit to retrieve.

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
edit_id
string
required

Query Parameters

​
access_token
string | null

Response

Successful Response

​
id
string
required

Unique identifier of the edit.

​
file
FileRef · object
required

Information about the source file (input document or template PDF).

​
model
string
required

Model used for the edit operation.

​
instructions
string
required

Instructions supplied with the edit request.

​
config
EditConfig · object
required

Configuration used for the edit operation.

​
data
EditResult · object
required

The edit result: filled form fields and the rendered PDF.

​
usage
RetabUsage · object
required

Usage information for the edit operation.

​
template_id
string | null

Template id used when the edit was created from a template; null for direct-document edits.

​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null