Quote an interview

POST

/api/v1/interview-quotes

Check the assigned configuration and applicable price before inviting a candidate. The returned fingerprint binds the invitation details to the quote you reviewed.

Before you call

Use a report with a usable completed analysis, candidateEmail, and sendEmail. Resolve mismatch review in the app first.

Required scope: interviews:write.

What happens next

Pass fingerprint as quoteFingerprint with the same report, email, and delivery choice to Invite a candidate. A quote sends no email and reserves no capacity.

Recovery

An unfinished or unusable analysis cannot be quoted for interview. Requote if the invitation details or assigned configuration change. Example prices are illustrative.

Follow the complete workflow · Errors and retries

Authorization

ApiKey

headerAuthorizationBearer <token>

Request Body

application/json

body

reportId*string

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

Length1 <= length <= 100

candidateEmail*string

Email address of the intended candidate. The quote and invitation must use the same address.

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

sendEmail?boolean

True (default) asks ProBB AI to email the invitation. False returns a private link credential for your system to deliver. Invitation batches require true.

Defaulttrue

Response Body

Pass fingerprint as quoteFingerprint with the same report, email, and delivery choice to Invite a candidate. A quote sends no email and reserves no capacity.

application/json

response

data*

# Set PROBB_URL and PROBB_API_KEY. Replace RESOURCE_ID if present.curl --fail-with-body -X POST "$PROBB_URL/api/v1/interview-quotes" \  -H "Authorization: Bearer $PROBB_API_KEY" \  -H 'Content-Type: application/json' \  --data-binary '{  "reportId": "report_example",  "candidateEmail": "candidate@example.test",  "sendEmail": true}'

{  "data": {    "reportId": "report_example",    "creditUnits": 100,    "creditScale": 100,    "fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",    "interviewSystemVersion": "assigned-interview-version"  }}