Skip to main content
GET
Get Document

Headers

authorization
string | null
X-Organization-ID
string | null

Path Parameters

document_id
string
required

Cookies

stytch_session
string | null

Response

Successful Response

Response model for document metadata.

document_id
string
required
file_size
integer
required
file_type
string
required
file_url
string
required
filename
string
required
job_id
string
required
organization_id
string
required
status
string
required
uploaded_at
string
required
uploaded_by
string
required
approval_status
string | null
default:pending_review

Governance status: pending_review, approved, rejected

approved_at
approved_by
string | null
available_columns
string[] | null
brand_key
string | null

Brand key (for pricing documents)

brand_name
string | null

Brand display name (e.g. 'New Balance')

changes_detected
integer | null

Number of changes detected vs previous policy

completed_at
string | null
document_category
string | null
default:product

Category: 'product' or 'pricing'

error_message
string | null
extracted_products
ExtractedProductSummary · object[] | null

Products extracted from this document (from the shared lakehouse)

extracted_technologies
ExtractedTechnologySummary · object[] | null

Technologies extracted from this document (from the shared lakehouse)

extraction_error
Extraction Error · object | null
extraction_review
Extraction Review · object | null

Review decision stamp: {confirmed_by, confirmed_at, note} on confirm, {rejected_by, rejected_at, rejection_reason} on reject

extraction_review_summary
Extraction Review Summary · object | null

{products, technologies, needs_attention, document_confidence, gate_decision} — written at pause and at auto-commit

extraction_warnings
Extraction Warnings · object[] | null
organization_name
string | null
policy_id
string | null

MAP policy ID created from this document

preview_rows
Preview Rows · object[] | null
prices_extracted
integer | null

Number of MAP prices extracted

prices_linked
integer | null

Number of prices linked to existing products

prices_unmatched
integer | null

Number of prices without product match

processing_completed_at
string | null
processing_error
string | null
processing_paused_at
string | null
processing_started_at
string | null
products_extracted
integer
default:0
products_needs_review
integer | null
rejection_reason
string | null
review_mode
string | null

Per-upload review override captured at upload (org_default|always|threshold|never)

rows_skipped
integer | null
skipped_rows_details
Skipped Rows Details · object[] | null
started_at
string | null
stubs_created
integer | null

Number of product stubs auto-created

technologies_extracted
integer
default:0
total_rows_processed
integer | null
uploaded_by_name
string | null