Live file-conversion events (SSE)
A Server-Sent Events stream telling the caller when a file they uploaded finishes converting to PDF (status "ready" or "failed"), replacing per-document polling. Scoped to the caller: only files on documents they own are reported, taken from the verified token. Frames carry ids and the new status only; re-read the document (GET /v1/documents/{id}) for the data. The stream emits `event: ready` once on connect (re-check any file you are waiting on — you may have missed an event while disconnected), then `event: conversion` with `{"documentId","fileId","status"}` as files settle, plus `: ping` heartbeat comments every 25s. The server ends the stream after 15 minutes; reconnect with a fresh token. Delivery is best-effort — keep a slow fallback poll of the document. Answers 503 when the server has no event listener; fall back to polling.
View as MarkdownAuthorization
bearer In: header
Response Body
text/event-stream
application/json
application/json
application/json
curl -X GET "https://example.com/v1/conversion-events""event: conversion\ndata: {\"documentId\":\"7f3e…\",\"fileId\":\"a91c…\",\"status\":\"ready\"}\n"Create a draft
Creates a draft. The PDF is attached separately (POST /v1/documents/{id}/file) and nothing is emailed until /send. With a templateId (public or owned), template fields are copied and — if no recipients were sent — template recipient slots are created with empty emails; template usageCount increments. An unresolvable templateId is a 400. Recipients passed here are created with status "pending".
Document detail
One document with recipients (ordered) and fields.