v1

latestOpenAPI 3.0.02026-07-22292140.8 KB
envelopes

Create an envelope

Creates a draft envelope with its participant and field graph. The document arrives by public URL, inline base64 content, chat-authored text rendered to PDF, a same-organization envelope document, or deferred upload ({ upload: true } returns a short-lived signed uploadUrl; it is never re-issued after create). Returns immediately with the envelope, a review URL for the web review page, a human/agent-readable note describing the next step, and never blocks on field detection. URL and inline documents enqueue field detection asynchronously after the document is stored (the envelope moves draft → detecting → review); deferred-upload envelopes skip detection and remain sendable with manually placed fields. Supports the Idempotency-Key header: a replayed completed key returns the envelope's current graph with the original status code and Idempotency-Replayed: true (never re-executing); an in-flight duplicate is rejected 409; reusing a key with a different request is rejected 422. A replayed create re-mints the review URL but never the one-shot upload URL.

post/api/v1/envelopes

Request body

displayNamestring
{"stackTrail":"paths:/api/v1/envelopes:post:requestBody:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown","nullable":true}

Response

Envelope created (status draft, version 1)

reviewUrlstring uri required
uploadUrlstring uri
notestring required