API reference
Choose an operation, understand its purpose, and use validated request and response examples.
Start with the API quickstart to run your first analysis, or use the developer overview to choose a workflow. Each endpoint explains prerequisites, what it changes, recovery, and its exact contract.
Base URL: your ProBB AI application origin, followed by /api/v1. Send a server-side Bearer key with the required scope. The webhook receiver is hosted by you.
Examples use synthetic IDs, illustrative prices, and placeholder assigned-version labels. Replace these with values returned by your workspace. Signed URLs and cursors shown in examples are not usable credentials.
Authentication · Concepts · Errors and retries · Developer sandbox · Download OpenAPI
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.
Refresh an upload URL
Get a fresh storage URL when the ten-minute upload URL has expired. Keep the same prepared report instead of creating a duplicate.
Cancel a pending upload
Release an unused preparation when an application is withdrawn or you no longer intend to upload its resume.
Analyses
Quote an analysis
Check the assigned report version and applicable price before starting analysis. The fingerprint binds the subsequent submission to the configuration you reviewed.
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.
Reports
Get a report summary
Read candidate and job context with a compact resume-analysis result. Use this for an application overview; use the detailed result endpoint for rubric evidence.
Get report status
Poll the small status response while analysis is running, or reconcile a delayed webhook with the current attempt.
List reports
Find reports in your workspace, reconcile stored application IDs, or backfill your local report index.
Get report evidence
Retrieve the versioned resume evaluation for an evidence-based review in your application. This includes rubric findings, supporting evidence, gaps, and follow-up questions.
Job descriptions
List job descriptions
Discover saved jobs so your integration can attach resumes to an existing role instead of copying job text into every request.
Get a job description
Read the full saved job and its content revision before attaching a candidate application.
Interviews
Quote an interview
Check the assigned configuration and applicable price before inviting a candidate. The returned fingerprint binds the invitation details to the quote you reviewed.
Invite a candidate
Create an interview attempt and prepare its questions. ProBB AI can send the invitation email, or your own system can deliver the candidate link.
List interviews
Find interview attempts for a report or external application, including prior attempts that remain available.
Get an interview
Read the independent candidate, preparation, evaluation, and email states of an interview attempt. Use this as the current attempt overview.
Get interview status
Read the independent candidate, preparation, evaluation, and email states of an interview attempt. Use this endpoint to poll after an invitation or reconcile webhook events.
Get interview evidence
Read the published evaluation for a specific interview attempt, including strengths, concerns, requirement coverage, and review limitations.
Resend an invitation
Queue another email for the same pending interview when the candidate needs the invitation again. This does not create a new interview or charge for one.
Create a reinterview
Create a new interview attempt for a candidate who needs another session. Unlike resend, this prepares a new interview and uses the current assigned version and allowance.
Batches
Create an upload batch
Queue several uploads in one durable request and track outcomes by your own itemKey. Use this to process an application import without coordinating every admission yourself.
Get upload batch status
Read individual outcomes from an accepted upload batch. Use itemKey to match each outcome to the original application row.
Create an analysis batch
Queue several analyses in one durable request and track outcomes by your own itemKey. Use this to process an application import without coordinating every admission yourself.
Get analysis batch status
Read individual outcomes from an accepted analysis batch. Use itemKey to match each outcome to the original application row.
Create an interview batch
Queue several interviews in one durable request and track outcomes by your own itemKey. Use this to process an application import without coordinating every admission yourself.
Get interview batch status
Read individual outcomes from an accepted interview batch. Use itemKey to match each outcome to the original application row.
Quote an analysis batch
Review per-item prices and fingerprints before creating an analysis batch. Use this to separate items ready for submission from items that need attention.
Quote an interview batch
Review per-item prices and fingerprints before creating an interview batch. Use this to separate items ready for submission from items that need attention.