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>",
"filename": "<string>"
},
"participants": [
{
"name": "<string>",
"email": "jsmith@example.com",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 1
}
],
"fields": [
{
"page": 2,
"x": 0.5,
"y": 0.5,
"width": 0.5,
"height": 0.5,
"participantIndex": 1,
"partyIndex": 1,
"label": "<string>",
"required": true,
"prefillValue": "<string>"
}
],
"displayName": "<string>",
"policy": {
"legalFramework": "<string>",
"consumerDisclosure": true,
"expiresAt": "2023-11-07T05:31:56Z",
"reminderPolicy": null
},
"metadata": null
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: {url: '<string>', filename: '<string>'},
participants: [
{
name: '<string>',
email: 'jsmith@example.com',
company: '<string>',
title: '<string>',
detectedPartyIndex: 1
}
],
fields: [
{
page: 2,
x: 0.5,
y: 0.5,
width: 0.5,
height: 0.5,
participantIndex: 1,
partyIndex: 1,
label: '<string>',
required: true,
prefillValue: '<string>'
}
],
displayName: '<string>',
policy: {
legalFramework: '<string>',
consumerDisclosure: true,
expiresAt: '2023-11-07T05:31:56Z',
reminderPolicy: null
},
metadata: null
})
};
fetch('https://api.atlaswork.ai/api/v1/envelopes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/v1/envelopes"
payload = {
"document": {
"url": "<string>",
"filename": "<string>"
},
"participants": [
{
"name": "<string>",
"email": "jsmith@example.com",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 1
}
],
"fields": [
{
"page": 2,
"x": 0.5,
"y": 0.5,
"width": 0.5,
"height": 0.5,
"participantIndex": 1,
"partyIndex": 1,
"label": "<string>",
"required": True,
"prefillValue": "<string>"
}
],
"displayName": "<string>",
"policy": {
"legalFramework": "<string>",
"consumerDisclosure": True,
"expiresAt": "2023-11-07T05:31:56Z",
"reminderPolicy": None
},
"metadata": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"envelope": {
"envelope": {
"id": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"templateId": "<string>",
"templateContentHash": "<string>",
"version": 123,
"originalFilename": "<string>",
"displayName": "<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,
"senderUserId": "<string>",
"senderName": "<string>",
"senderEmail": "<string>",
"detectedParties": 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",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 123
}
],
"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>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
]
},
"reviewUrl": "<string>",
"note": "<string>",
"uploadUrl": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}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
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>",
"filename": "<string>"
},
"participants": [
{
"name": "<string>",
"email": "jsmith@example.com",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 1
}
],
"fields": [
{
"page": 2,
"x": 0.5,
"y": 0.5,
"width": 0.5,
"height": 0.5,
"participantIndex": 1,
"partyIndex": 1,
"label": "<string>",
"required": true,
"prefillValue": "<string>"
}
],
"displayName": "<string>",
"policy": {
"legalFramework": "<string>",
"consumerDisclosure": true,
"expiresAt": "2023-11-07T05:31:56Z",
"reminderPolicy": null
},
"metadata": null
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: {url: '<string>', filename: '<string>'},
participants: [
{
name: '<string>',
email: 'jsmith@example.com',
company: '<string>',
title: '<string>',
detectedPartyIndex: 1
}
],
fields: [
{
page: 2,
x: 0.5,
y: 0.5,
width: 0.5,
height: 0.5,
participantIndex: 1,
partyIndex: 1,
label: '<string>',
required: true,
prefillValue: '<string>'
}
],
displayName: '<string>',
policy: {
legalFramework: '<string>',
consumerDisclosure: true,
expiresAt: '2023-11-07T05:31:56Z',
reminderPolicy: null
},
metadata: null
})
};
fetch('https://api.atlaswork.ai/api/v1/envelopes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/v1/envelopes"
payload = {
"document": {
"url": "<string>",
"filename": "<string>"
},
"participants": [
{
"name": "<string>",
"email": "jsmith@example.com",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 1
}
],
"fields": [
{
"page": 2,
"x": 0.5,
"y": 0.5,
"width": 0.5,
"height": 0.5,
"participantIndex": 1,
"partyIndex": 1,
"label": "<string>",
"required": True,
"prefillValue": "<string>"
}
],
"displayName": "<string>",
"policy": {
"legalFramework": "<string>",
"consumerDisclosure": True,
"expiresAt": "2023-11-07T05:31:56Z",
"reminderPolicy": None
},
"metadata": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"envelope": {
"envelope": {
"id": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"templateId": "<string>",
"templateContentHash": "<string>",
"version": 123,
"originalFilename": "<string>",
"displayName": "<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,
"senderUserId": "<string>",
"senderName": "<string>",
"senderEmail": "<string>",
"detectedParties": 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",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 123
}
],
"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>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
]
},
"reviewUrl": "<string>",
"note": "<string>",
"uploadUrl": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}Authorizations
apiKeyoauthJwt
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
⌘I