Interviews

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.

Before you call

Obtain a current interview quote and send the same details plus quoteFingerprint with a stable Idempotency-Key. The workspace must have interview allowance.

Required scope: interviews:write.

What happens next

A 202 returns interviewId and statusUrl. With sendEmail=true, invitationToken is null. With false, securely deliver /interview/{invitationToken} on the application origin yourself. Preparation and email delivery proceed independently.

Recovery

Repeat the same body/key after a timeout. A returned token is a bearer credential; never log it. Replays only recover an eligible current pending invitation. Use resend for another email and reinterview for a new attempt.

Follow the complete workflow · Errors and retries

post/api/v1/interviews

Request

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

candidateEmailstring email required

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

sendEmailboolean

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

quoteFingerprintstring required

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

Response

Changes

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