Read a spec’s table of contents

Spec TOC parsing · model toc-parser

POST/v1/specs/parse/document

Queue TOC / spec structure extraction from a PDF already in ag_documents — the same upload as POST /v1/documents, not a second upload. Job model is toc-parser. Worker reads up to 40 pages of text and parses TOC lines from the document.

X-API-Key and Content-Type: application/json. Async: immediate 202 with a new job id, then poll GET /v1/jobs/{job_id}. This path is in the tier RPM limiter with other job-submit POSTs. See pricing for how jobs are counted (402 when a trial allowance is used up, 429 when a monthly allowance is). Optional webhook_url: delivery from the worker requires tier developer, pro, or enterprise.

Returns: A job to check202 Accepted
Usage: Document indexingper page read (up to 40)
Results in: Divisions and sectionsresult.divisions
Auth: API keyX-API-Key header

Some schema docstrings still reference POST /v1/specs/parse; that path does not exist. Use /v1/specs/parse/document (required for content-extract).

How it runs

Send a document_id
Get a job_id
Check your results or receive a webhook

Request

This endpoint requires a document_id. Upload your PDF first.

Body type: ParseSpecByDocumentRequest.

Field	Description
`document_id`string · UUIDRequired	Document in ag_documents for your account; must not be missing, wrong account, or expired.
`webhook_url`string · URLOptional	Honored on developer, pro, enterprise for worker delivery.

Header	Description
`X-API-Key`Required	Your API key. A missing or invalid key returns 401.
`Content-Type`Required	`application/json`

Responses

Shape: ParseJobQueued. Poll until status is complete or failed.

Field	Description
`job_id`string · UUID	Use this to poll for results.
`status`string	queued on this response.
`estimated_processing_seconds`integer	Hint only (e.g. 15).
`poll_url`string	Path only — prepend `https://api.anchorgrid.ai` to build the full URL.

When status is complete and model is toc-parser. Division/section shape comes from TOCParser.parse_toc_structure (division_code, division_title, sections[] with section_code as 6 digits and section_title). GET /v1/jobs does not post-filter toc-parser results.

Field	Description
`toc_found`boolean	false if no TOC detected.
`division_count`integer	Typically 0 when toc_found is false.
`section_count`integer	Typically 0 when toc_found is false.
`divisions`array	Typically [] when toc_found is false.
`toc_found_reason`string	Optional when toc_found is false — e.g. nothing structured in first 40 pages.
`model_version`string	e.g. `toc-parser-v1.0.0`
`processing_time_ms`integer	Wall time.

Usage & rate limits

Each job counts as one document-indexing page (See pricing). Rate limit: tier RPM (job-submit bucket).

Errors

Handler detail; Intelligence may still genericize JSON.

Status	What it means
401	Invalid or missing API key.
422	Bad JSON / invalid document_id.
404	Document missing, wrong account, or expired (DOCUMENT_NOT_FOUND).
402 / 429	Plan allowance used up.
429	RPM limit (middleware).

Worker failures → job failed with an error object (code such as URL_UNREACHABLE, PDF_CORRUPT or INTERNAL_ERROR, and a message) — poll GET /v1/jobs.

See Errors for HTTP exception mapping.

Typical flow

Continue with POST /v1/specs/content-extract using the completed TOC job_id and section or division codes.

Examples

curl -X POST https://api.anchorgrid.ai/v1/specs/parse/document \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "document_id": "550e8400-e29b-41d4-a716-446655440000"
  }'

Response · 202

{
  "job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "queued",
  "estimated_processing_seconds": 15,
  "poll_url": "/v1/jobs/7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Completed job · result

{
  "toc_found": true,
  "division_count": 3,
  "section_count": 42,
  "divisions": [
    {
      "division_code": "03",
      "division_title": "Concrete",
      "sections": [
        {
          "section_code": "033000",
          "section_title": "Cast-in-Place Concrete"
        }
      ]
    }
  ],
  "model_version": "toc-parser-v1.0.0",
  "processing_time_ms": 12000
}

Cookies & analytics