Create an envelope

curl --request POST \
  --url https://api.atlaswork.ai/api/v1/envelopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "url": "<string>"
  },
  "participants": [
    {
      "name": "<string>",
      "email": "jsmith@example.com"
    }
  ],
  "fields": [
    {
      "participantIndex": 1,
      "page": 2,
      "x": 0.5,
      "y": 0.5,
      "width": 0.5,
      "height": 0.5,
      "label": "<string>",
      "required": true,
      "prefillValue": "<string>"
    }
  ],
  "policy": {
    "legalFramework": "<string>",
    "consumerDisclosure": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "reminderPolicy": null
  },
  "metadata": null
}
'

{
  "envelope": {
    "envelope": {
      "id": "<string>",
      "organizationId": "<string>",
      "version": 123,
      "originalFilename": "<string>",
      "sourceFormat": "<string>",
      "contentHash": "<string>",
      "sizeBytes": 123,
      "deliveryMode": "<string>",
      "legalFramework": "<string>",
      "consumerDisclosure": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "scheduledSendAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "declinedAt": "2023-11-07T05:31:56Z",
      "voidedAt": "2023-11-07T05:31:56Z",
      "expiredAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "reminderPolicy": null,
      "metadata": null
    },
    "participants": [
      {
        "id": "<string>",
        "envelopeId": "<string>",
        "organizationId": "<string>",
        "orderIndex": 123,
        "name": "<string>",
        "email": "<string>",
        "consentedAt": "2023-11-07T05:31:56Z",
        "signedAt": "2023-11-07T05:31:56Z",
        "declinedAt": "2023-11-07T05:31:56Z",
        "declineReason": "<string>",
        "lastViewedAt": "2023-11-07T05:31:56Z",
        "lastIpAddress": "<string>",
        "lastUserAgent": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "fields": [
      {
        "id": "<string>",
        "envelopeId": "<string>",
        "organizationId": "<string>",
        "participantId": "<string>",
        "page": 123,
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123,
        "label": "<string>",
        "required": true,
        "prefillValue": "<string>",
        "value": "<string>",
        "filledAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "reviewUrl": "<string>",
  "note": "<string>",
  "uploadUrl": "<string>"
}

envelopes

Create an envelope

Creates a draft envelope with its participant and field graph. The document arrives by public URL, inline base64 content, 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

envelopes

Create an envelope

curl --request POST \
  --url https://api.atlaswork.ai/api/v1/envelopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "url": "<string>"
  },
  "participants": [
    {
      "name": "<string>",
      "email": "jsmith@example.com"
    }
  ],
  "fields": [
    {
      "participantIndex": 1,
      "page": 2,
      "x": 0.5,
      "y": 0.5,
      "width": 0.5,
      "height": 0.5,
      "label": "<string>",
      "required": true,
      "prefillValue": "<string>"
    }
  ],
  "policy": {
    "legalFramework": "<string>",
    "consumerDisclosure": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "reminderPolicy": null
  },
  "metadata": null
}
'

{
  "envelope": {
    "envelope": {
      "id": "<string>",
      "organizationId": "<string>",
      "version": 123,
      "originalFilename": "<string>",
      "sourceFormat": "<string>",
      "contentHash": "<string>",
      "sizeBytes": 123,
      "deliveryMode": "<string>",
      "legalFramework": "<string>",
      "consumerDisclosure": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "scheduledSendAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "declinedAt": "2023-11-07T05:31:56Z",
      "voidedAt": "2023-11-07T05:31:56Z",
      "expiredAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "reminderPolicy": null,
      "metadata": null
    },
    "participants": [
      {
        "id": "<string>",
        "envelopeId": "<string>",
        "organizationId": "<string>",
        "orderIndex": 123,
        "name": "<string>",
        "email": "<string>",
        "consentedAt": "2023-11-07T05:31:56Z",
        "signedAt": "2023-11-07T05:31:56Z",
        "declinedAt": "2023-11-07T05:31:56Z",
        "declineReason": "<string>",
        "lastViewedAt": "2023-11-07T05:31:56Z",
        "lastIpAddress": "<string>",
        "lastUserAgent": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "fields": [
      {
        "id": "<string>",
        "envelopeId": "<string>",
        "organizationId": "<string>",
        "participantId": "<string>",
        "page": 123,
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123,
        "label": "<string>",
        "required": true,
        "prefillValue": "<string>",
        "value": "<string>",
        "filledAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "reviewUrl": "<string>",
  "note": "<string>",
  "uploadUrl": "<string>"
}

Authorizations

Authorization

string

header

required

Organization API key (format atlas_sk_...), passed as a bearer token or the x-api-key header. Created and revoked in the dashboard (Better Auth api-key plugin); shown in full only once and stored hashed.

Body

application/json

document

object

required

Option 1
Option 2
Option 3

Show child attributes

participants

object[]

required

Show child attributes

fields

object[]

required

Show child attributes

policy

object

Show child attributes

metadata

unknown

Response

Envelope created (status draft, version 1)

envelope

object

required

Show child attributes

reviewUrl

string<uri>

required

note

string

required

uploadUrl

string<uri>

List envelopes Get an envelope

⌘I