Generate Document Outline

POST

/api/outline

Generate a structured outline from a PDF document using AI. The outline includes source metadata, chapter information, segment titles, summaries, and Hebrew start/end phrases. Supports multiple AI providers (Gemini, OpenAI) for comparison.

Request

Query Params

Body Params multipart/form-dataRequired

Responses

🟢200Success

application/json

Document outline (single provider) or comparison (multiple providers)

Body

🟠400400

🔴500500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/outline?providers=gemini' \
--form 'file=@""'

Response Example

200 - Example 1

{
    "source_metadata": {
        "publication_title": "לקוטי שיחות",
        "work_title": "תרומה - שיחה א",
        "author_name": "כ\"ק אדמו\"ר"
    },
    "outline_segments": [
        {
            "sequence_id": 0,
            "chapter_number": "string",
            "chapter_title": "string",
            "segment_title": "string",
            "summary": "string",
            "page_ref": "string",
            "start_phrase_hebrew": "string",
            "end_phrase_hebrew": "string"
        }
    ]
}

Modified at 2025-12-03 11:51:17

Extract Text from Document

Process Complete Document