Restart or retake the interview
A pending or absent session is (re)started (crash recovery, does not consume a retake); a finished session that can be retaken is retaken; a finished session at its retake limit returns 409; a running session is a 202 no-op. Accepts an Idempotency-Key header.
Authorizations
API key authentication for the public API. Pass your API key as a Bearer token.
Headers
Unique key (e.g. a UUID v4) that makes this POST safe to retry: a repeated key replays the original response instead of creating a second resource.
Path Parameters
Response
Interview (re)started or in-flight.
Session envelope + nested result. result is null until completed.
Snapshot of the interview config mode at session creation time.
web- Webphone- Phone
web, phone Language of the interview session.
en-US- Englishde-DE- German
en-US, de-DE The scored result body. Null on the session until status==completed.
Current status of the interview session, which determines next steps in the interview process.
pending- Pendingscheduled- Scheduledin_progress- In Progressrescheduled- Rescheduledretry_scheduled- Retry Scheduledcompleted- Completedopted_out- Opted Outunreachable- Unreachablelanguage_barrier- Language Barrierfailed- Failedcancelled- Cancelled
pending, scheduled, in_progress, rescheduled, retry_scheduled, completed, opted_out, unreachable, language_barrier, failed, cancelled [Scheduling enabled only] Scheduled date and time for the interview. Populated only when the interview config's scheduling is enabled. Null otherwise.
Number of retakes. 0 = original attempt, 1 = first retake.
0 <= x <= 2147483647Number of call retry attempts within the current retake. Reset on each retake.
0 <= x <= 2147483647Timestamp of the last update to the interview session status. Updated each time the status changes.
Error details when the session fails or is unreachable.

