---
title: "Outline of a PDF"
method: POST
path: "/v1/tools/pdf_outline"
tags: ["Tools"]
---

# Outline of a PDF

`POST /v1/tools/pdf_outline`

## Request

- Base URL: `http://127.0.0.1:7341`
- URL: `http://127.0.0.1:7341/v1/tools/pdf_outline`
- Auth: HTTP bearer

The document's outline (from bookmarks or detected headings) as a Markdown list or JSON tree, with the pages each section covers.

Same tool as the MCP server's pdf_outline. Runs before responding; for long work, POST /v1/jobs instead.

## Request body

- PdfOutlineInput
  - `input` string, required: Path to a PDF inside an allowed folder (absolute, or relative to the first allowed folder).
  - `format` 'markdown' | 'json'

## Response `200`

The result. Any new files are written inside the allowed folders.

- PdfOutlineResult
  - `format` string, required
  - `content` string, required
  - `sections` unknown[], required
    - unknown

## Other responses

- `400`: The body is not valid JSON.
- `401`: The bearer token is missing or wrong.
- `403`: The Host or Origin header is not allowed.
- `409`: The output file already exists. superPDF never overwrites; choose a new name.
- `413`: The body is larger than 1 MB.
- `415`: The body is not application/json.
- `422`: Invalid input (errors names each field), a path outside the allowed folders, or a document the tool could not process.
- `429`: Too many tool calls are running and waiting (4 at once, 2 of them LibreOffice conversions; 64 more wait their turn).
- `500`: Unexpected server failure.

---

[API](https://skmtc.dev/superpdf/apis/superpdf-local-api.md) · [All operations](https://skmtc.dev/superpdf/apis/superpdf-local-api/llms.txt) · [OpenAPI document](https://skmtc.dev/superpdf/apis/superpdf-local-api/revisions/53f71d44b156?raw)