Skip to main content
GET
Fetch contract field detections
Retrieve the latest extraction result for a previously submitted document, optionally filtered to a specific page.
The API Playground above uses the endpoint to send live requests and inspect responses without leaving the docs.

Request

  • Method: GET
  • URL: https://api.contractag.dev/fields/{document_id}
  • Query Parameters:
    • page — Optional. 1-indexed page number to filter by.
  • Headers:
    • x-api-key: YOUR_API_KEY (optional)
To filter by page:

Response

When no page parameter is provided, returns all fields:
When page is specified, returns fields for that page only:
Responses include coordinates and confidence only. Render bounding boxes over the source PDF to view the underlying text.

Errors

  • 404 — Document ID not found or expired (default retention is 30 days).
  • 410 — Document purged; re-upload required.
  • 422 — Invalid page parameter.
  • 429 — Rate limit exceeded; see response headers for reset window.

Headers

x-api-key
string | null

Path Parameters

document_id
string
required

Query Parameters

page
integer | null

Response

Successful Response

documentId
string
required
pages
integer
required
fields
FieldDetection · object[]
required
createdAt
string<date-time>
required