Documents

Reserve a document upload

Request a five-minute upload capability for one immutable file.

POST/v1/documents/uploads

Requester role requiredIntegration key: runs:start; or a user token with the required role.

How it works

Requires runs:start or requester access and Idempotency-Key. Flow version must be published and document field/type/size configured. PUT the actual file bytes to upload.url, sending every upload.headers value exactly. Do not send your flow2act token to S3. Upload capability does not grant read access. SHA-256 is lowercase hexadecimal over the exact file bytes; S3 validates the signed checksum and a conditional write prevents overwrites. Retrying the same reservation may refresh its transient upload URL.

Request body

flowVersionIdstringrequireduuid

fieldKeystringrequired

fileNamestringrequiredmin length 1 · max length 180

contentTypestringrequiredapplication/pdf | image/png | image/jpeg | application/vnd.openxmlformats-officedocument.wordprocessingml.document

sizeintegerrequiredmin 1 · max 26214400

sha256stringrequired

Required fields & full validation schema → OpenAPI

Request essentials

Authorization: Bearer $FLOW2ACT_API_KEY
X-Organization-Id: Your workspace UUID
Idempotency-Key: Stable per operation; 8–128 characters

Have an implementation question?Ask about this endpoint. Answers include source references.

curl -X POST "https://api.flow2act.com/v1/documents/uploads" \ -H "authorization: Bearer $FLOW2ACT_API_KEY" \ -H "x-organization-id: 10000000-0000-4000-8000-000000000001" \ -H "idempotency-key: example-document-upload-001" \ -H "content-type: application/json" \ --data-raw '{ "flowVersionId": "10000000-0000-4000-8000-000000000003", "fieldKey": "contract", "fileName": "contract.pdf", "contentType": "application/pdf", "size": 1234, "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }'

{ "document": { "id": "10000000-0000-4000-8000-000000000012", "status": "uploading" }, "upload": { "url": "https://private-bucket.s3.eu-central-1.amazonaws.com/<temporary-upload-capability>", "headers": { "content-type": "application/pdf", "x-amz-checksum-sha256": "<base64 checksum>", "if-none-match": "*" }, "expiresAt": "2026-10-18T12:05:00.000Z" } }

Documents

Reserve a document upload

Request a five-minute upload capability for one immutable file.

POST/v1/documents/uploads

Requester role requiredIntegration key: runs:start; or a user token with the required role.

How it works

Request body

flowVersionIdstringrequireduuid

fieldKeystringrequired

fileNamestringrequiredmin length 1 · max length 180

contentTypestringrequiredapplication/pdf | image/png | image/jpeg | application/vnd.openxmlformats-officedocument.wordprocessingml.document

sizeintegerrequiredmin 1 · max 26214400

sha256stringrequired

Required fields & full validation schema → OpenAPI

Request essentials

Authorization: Bearer $FLOW2ACT_API_KEY
X-Organization-Id: Your workspace UUID
Idempotency-Key: Stable per operation; 8–128 characters

Have an implementation question?Ask about this endpoint. Answers include source references.

Reserve a document upload

How it works

Request body

Request essentials

Ask the docs

Reserve a document upload

How it works

Request body

Request essentials

Ask the docs