Skip to main content
POST
Detect contract fields across all pages
Upload a contract PDF and receive all detected fields in a single response.
Use the API Playground above to upload sample PDFs, tweak parameters, and inspect live responses without leaving the docs.

Request

  • Method: POST
  • URL: https://api.contractag.dev/fields
  • Headers:
    • x-api-key: YOUR_API_KEY (optional)
  • Body:
    • file — Required. PDF file upload.

Upload Limits

  • Maximum file size: 25 MB
  • Accepted mime types: application/pdf
  • Multi-page contracts supported (up to 150 pages)

Response

Field Object

Contractag does not return raw text; overlay bounding boxes on the original PDF to display values.

Status Codes

  • 200 — Extraction completed and results returned.
  • 400 — Invalid file or request parameters.
  • 401 — Missing/invalid API key.
  • 413 — File size exceeds limit.

Headers

x-api-key
string | null

Body

multipart/form-data
file
file
required

PDF contract

Response

Successful Response

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