Guides / Extract

PDF outline

POST /v1/pdf/outline  · 

Read the bookmark/chapter outline of a PDF as JSON with target pages – chapter boundaries for clean RAG chunking.

Parameters

NameTypeDescription
filefile · requiredPDF to read the outline from.

Example request

curl -X POST https://api.bigapi.dev/v1/pdf/outline -H 'Authorization: Bearer $KEY' -F 'file=@book.pdf'

Example response

{
  "has_outline": true, "entries": 12, "total_pages": 240,
  "flat": [ { "title": "Chapter 1", "page": 5, "depth": 1 } ],
  "_meta": { "op": "pdf.outline", "durationMs": 41.0 }
}

Related guides