Skip to main content
POST
Request document upload URL

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Body

application/json
originalFilename
string
required
Minimum string length: 1
contentType
enum<string>
required
Available options:
application/pdf,
application/msword,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
text/plain,
text/markdown,
text/html,
image/jpeg,
image/png,
image/webp,
image/gif
fileSizeBytes
integer
Required range: 0 <= x <= 9007199254740991

Response

Resource created successfully

fileId
string
required
Minimum string length: 1
Pattern: ^file_[a-z0-9]{26}$
uploadUrl
string
required

Signed URL to PUT the raw file bytes to

expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
originalFilename
string
required
contentType
string
required
maxFileSizeBytes
integer
required
Required range: x <= 9007199254740991