create

POST

/public/envelope/create

• Enclave API server

Create an envelope and the first document placeholder. Optionally accepts a small file directly (max 10 MB) in the request body. If a file is provided, it will be processed and uploaded directly. Otherwise, returns upload parameters for document upload.

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace to create the envelope in.

string

>= 36 characters <= 36 characters

envelopeTitle

required

The title of the envelope being created.

string

<= 255 characters

file

Base64-encoded PDF file data (max 10 MB). If provided, the file will be processed and uploaded directly, and presignedS3Params will not be returned.

string format: base64

<= 10485760 characters /^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$/

Responses

200

Default Response

object

envelopeUuid

required

The unique identifier of the created envelope.

string

documentUuid

required

The unique identifier of the first document.

string

presignedS3Params

Upload parameters for document upload. Only returned when no file is provided in the request.

object

url

required

The URL for uploading the document.

string

fields

required

Fields required for the upload.

object

bucket

required

The bucket name.

string

key

required

The object key.

string

content-type

required

The content type.

string

x-amz-algorithm

required

The algorithm.

string

x-amz-credential

required

The credential.

string

x-amz-date

required

The date.

string

policy

required

The policy.

string

x-amz-signature

required

The signature.

string

revisionEncryptionKey

required

The key in base64 for the document revision.

string

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WORKSPACE_NOT_FOUND INVALID_FILE_DATA FILE_SIZE_EXCEEDED INVALID_PDF INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

401

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

403

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

500

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string