Pitch Deck

Render a finished pitch deck's PDF on demand.

Render the PDF of a finished deck on demand. The first PDF comes with the deck only when the create request carried includePdf: true; this asks for one afterwards — a deck made without it, or an earlier PDF that failed. ONLY A complete DECK RENDERS ONE. A queued or rendering export short-circuits instead of stacking, and a deck whose PDF is already ready is the export worker's own no-op. NOT metered and NOT confirmed. Requires Idempotency-Key. Scope: story:write.

post/pitch-decks/{jobId}/pdf

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/pitch-decks/{jobId}/pdf
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Response

The PDF state after the request.

pdfStatusstring required

The PDF state: queued, rendering, ready, failed or idle.

pdfFindingsstring[] required

What the deck's PDF could not show, one plain sentence naming the chapter picture and the reason. NON-FATAL: the PDF still ships. Empty when every picture read.

Changes

No recorded changes to this operation across all 1 revision of this API.