latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

File Uploads

Create a file upload

Returns a single-use upload URL and a fileUploadId. Upload the file's bytes to uploadUrl with an HTTP PUT (sending the same Content-Type you declared), then attach the upload to a target by passing the fileUploadId to one of the /upload endpoints. Lets you upload large files without sending them through the API.

post/file-uploads

Request body

filenamestring required

The original file name, including its extension.

contentTypestring required

The MIME type of the file (e.g. application/pdf). You must send this exact value as the Content-Type header when uploading to uploadUrl.

sizeBytesinteger required

The size of the file in bytes.

Response

Example response

{
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}