PRprocess
File Uploads

Create a file upload

Changed on

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

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/file-uploads
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

filenamestring required

The original file name, including its extension. The extension, after the last ., can be at most 16 characters.

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"
    }
  ]
}

Changes

  • 803400d88b51Revision changes
    • warning

      the request property's maxLength was set to 256

    • info

      the request property's maxLength was increased from 255 to 256