Uploads

Prepare a resume upload

Create a report and a temporary upload destination before analysing a resume. Use this to connect one candidate application to a job description. This step does not start analysis.

Before you call

Have one PDF or DOCX (up to 10 MiB), its exact byte length, and job text or an active saved job ID. Choose a stable Idempotency-Key for this preparation.

Required scope: analyses:write.

What happens next

Save reportId, then PUT the file bytes to upload.url using upload.mimeType. Do not send your API key to storage. The URL lasts ten minutes; the preparation lasts 24 hours. After uploading, request an analysis quote.

Recovery

Repeat the identical body/key after a timeout. EXTERNAL_REFERENCE_CONFLICT means the application reference is already used. JD_REVISION_CHANGED requires reviewing the updated job. PENDING_UPLOAD_LIMIT requires cancelling unused preparations or waiting for expiry.

Follow the complete workflow · Errors and retries

post/api/v1/uploads

Request

  • Base URL: https://app.probbai.com
  • URL: https://app.probbai.com/api/v1/uploads
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable key for one logical write. Retry the identical body with the same key after a timeout; a changed body conflicts. 1–128 letters, digits, dots, underscores, colons, or hyphens.

Request body

fileNamestring required

Original PDF or DOCX filename, including extension. Paths and control characters are rejected.

fileSizeinteger required

Exact file byte length, from 1 to 10,485,760. This is not the number of characters or a megabyte count.

mimeType'application/pdf' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' required

File content type. The file extension, declared type, and uploaded content must agree.

Response

Save reportId, then PUT the file bytes to upload.url using upload.mimeType. Do not send your API key to storage. The URL lasts ten minutes; the preparation lasts 24 hours. After uploading, request an analysis quote.

Changes

No recorded changes to this operation across all 1 revision of this API.