Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
File

file.createFileUploadHandle

Creates a presigned upload URL that allows uploading a file directly to storage, bypassing the need to send file bytes through the API.

The presigned URL expires after 10 minutes. The fileUploadContext must be one of CandidateResume, CandidateFiles, or ApplicationForm.

Requires the candidatesWrite permission.

post/file.createFileUploadHandle

Request body

fileUploadContext'CandidateResume' | 'CandidateFiles' | 'ApplicationForm' required

The context for the file upload

filenamestring required

The name of the file being uploaded, including extension

contentTypestring required

The MIME type of the file being uploaded

contentLengthinteger required

The size of the file in bytes

Example request

{
  "fileUploadContext": "CandidateResume",
  "filename": "resume.pdf",
  "contentType": "application/pdf",
  "contentLength": 102400
}

Response

Responses from the file.createFileUploadHandle endpoint

OR

Example response

{
  "success": true,
  "results": {
    "handle": "encrypted-file-upload-handle",
    "url": "https://uploads.example.com/",
    "fields": {
      "key": "organization/file/resume.pdf",
      "acl": "private"
    }
  }
}