Analyses

Start an analysis

Submit the uploaded resume for asynchronous analysis against its job description. Use this after a successful storage upload and a current quote.

Before you call

Send the prepared reportId, quoteFingerprint, and a stable Idempotency-Key. Capacity and the workspace allowance are checked at admission.

Required scope: analyses:write.

What happens next

A 202 means the analysis was accepted, not completed. Save attemptId and follow statusUrl or report events. The accepted file is frozen for this attempt.

Recovery

Retry identical requests after timeouts. QUOTE_STALE needs a new quote/key. INVALID_UPLOAD needs a corrected upload. ACTIVE_ANALYSIS_LIMIT means wait for capacity. After terminal failure, a deliberate new attempt needs a new key/current quote; completed analyses cannot be restarted here.

Follow the complete workflow · Errors and retries

post/api/v1/analyses

Request

  • Base URL: https://app.probbai.com
  • URL: https://app.probbai.com/api/v1/analyses
  • 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

reportIdstring required

Report ID returned by upload preparation, admission, discovery, or an event. It must belong to the API key's workspace.

quoteFingerprintstring required

Fingerprint copied unchanged from the corresponding current quote. Changing quote inputs requires a new quote.

Response

A 202 means the analysis was accepted, not completed. Save attemptId and follow statusUrl or report events. The accepted file is frozen for this attempt.

Changes

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