Documents

List Files In User Bucket

get

List the files in the user bucket.

Path parameters
org_idstringRequired

The organization ID

user_idstringRequired

The user ID

flow_idstringRequired

The flow ID of the document

node_idstringRequired

The node ID of the document

Responses
200

Successful Response

application/json
Responsestring[]
get
GET /documents/{org_id}/{flow_id}/{node_id}/{user_id} HTTP/1.1
Host: 
Accept: */*
[
  "text"
]

Upload To User Bucket

post

Upload the file to the user bucket for a document node.

Path parameters
org_idstringRequired

The organization ID

user_idstringRequired

The user ID

flow_idstringRequired

The flow ID of the document

node_idstringRequired

The node ID of the document

Body
anyOptional
Responses
200

Successful Response

application/json
Responseobject · ResponseUploadToUserBucketDocumentsOrgIdFlowIdNodeIdUserIdPost
post
POST /documents/{org_id}/{flow_id}/{node_id}/{user_id} HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
{}

Delete From User Bucket

delete

Delete the file from the user bucket.

Path parameters
org_idstringRequired

The organization ID

user_idstringRequired

The user ID

flow_idstringRequired

The flow ID of the document

node_idstringRequired

The node ID of the document

Query parameters
filenamestringRequired
Responses
200

Successful Response

application/json
delete
DELETE /documents/{org_id}/{flow_id}/{node_id}/{user_id}?filename=text HTTP/1.1
Host: 
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": true
}

Download From User Bucket

get

Download the file from the user bucket.

Path parameters
org_idstringRequired

The organization ID

user_idstringRequired

The user ID

flow_idstringRequired

The flow ID of the document

node_idstringRequired

The node ID of the document

Query parameters
filenamestringRequired
Responses
200

Successful Response

application/json
Responseany
get
GET /documents/{org_id}/{flow_id}/{node_id}/{user_id}/file?filename=text HTTP/1.1
Host: 
Accept: */*

No content

Was this helpful?