Skip to main content
GET
/
v1
/
extractions
/
download
from datetime import datetime
from retab import Retab

client = Retab()

# Download as JSONL (default)
result = client.extractions.download(
    format="jsonl",
    from_date=datetime(2024, 1, 1)
)
print(f"Download URL: {result['download_url']}")
print(f"Expires at: {result['expires_at']}")

# Download as CSV
result = client.extractions.download(
    format="csv",
    metadata={"organization_id": "org_acme_corp"}
)

# Download as Excel with filters
result = client.extractions.download(
    format="xlsx",
    human_review_status="reviewed",
    from_date=datetime(2024, 1, 1),
    to_date=datetime(2024, 12, 31)
)

{
  "download_url": "https://storage.googleapis.com/retab-extractions/org_01ABC123/extractions_dump/retab_extractions_all_2024-01-01_2024-12-31.jsonl?X-Goog-Algorithm=...",
  "filename": "retab_extractions_all_2024-01-01_2024-12-31.jsonl",
  "expires_at": "2024-03-15T15:30:00Z"
}

from datetime import datetime
from retab import Retab

client = Retab()

# Download as JSONL (default)
result = client.extractions.download(
    format="jsonl",
    from_date=datetime(2024, 1, 1)
)
print(f"Download URL: {result['download_url']}")
print(f"Expires at: {result['expires_at']}")

# Download as CSV
result = client.extractions.download(
    format="csv",
    metadata={"organization_id": "org_acme_corp"}
)

# Download as Excel with filters
result = client.extractions.download(
    format="xlsx",
    human_review_status="reviewed",
    from_date=datetime(2024, 1, 1),
    to_date=datetime(2024, 12, 31)
)

{
  "download_url": "https://storage.googleapis.com/retab-extractions/org_01ABC123/extractions_dump/retab_extractions_all_2024-01-01_2024-12-31.jsonl?X-Goog-Algorithm=...",
  "filename": "retab_extractions_all_2024-01-01_2024-12-31.jsonl",
  "expires_at": "2024-03-15T15:30:00Z"
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
order
enum<string>
default:desc
Available options:
asc,
desc
​
origin_dot_id
string | null
​
from_date
string | null
​
to_date
string | null
​
human_review_status
enum<string> | null
Available options:
success,
review_required,
reviewed
​
metadata
string | null
​
filename
string | null
​
format
enum<string>
default:jsonl
Available options:
jsonl,
csv,
xlsx
​
access_token
string | null

Response

Successful Response

The response is of type object.