SessionSummary

iduuidrequired

client_iduuidrequired

persona_iduuidrequired

candidate_refstringnullable

Your opaque candidate reference, if supplied at session creation.

statusstringrequired

• initiated — session created, candidate link minted, not yet started
• active — candidate opened the link; interview in progress
• completed — interview ended normally; recording/transcript available
• failed — the session failed; no credits charged

Possible values: [initiated, active, completed, failed]

consent_modestringrequired

Possible values: [explicit, integrator]

sourcestring

Which surface created the session. requests = started via the X-API-Key API (headless integration); playground = started from the ZenHire console. Sessions you create with an API key are always requests.

Possible values: [requests, playground]

project_iduuidnullable

The project this session is attributed to. For an X-API-Key session this is inherited from the calling key's project (null when the key has none).

tagsstring[]nullable

The tags supplied at session creation (null when none).

metadata objectnullable

The metadata map supplied at session creation (null when none).

property name*anynullable

The metadata map supplied at session creation (null when none).

started_atdate-timenullable

completed_atdate-timenullable

duration_secintegernullable

credit_chargedintegernullable

Credits charged on completion (per-minute interview rate).

recording_s3_keystringnullable

Storage reference only — fetch the recording via the recording endpoint.

transcript_s3_keystringnullable

Storage reference only — fetch the transcript via the transcript endpoint.

interview_svc_session_idstringnullable

The interview backend's session id (set on completion).

created_atdate-timerequired

role_namestringnullable

The persona's role name. Included on list rows (GET /sessions) for convenience; null if the persona was deleted. On the single-session response the role is under persona instead.

languagestringnullable

The persona's interview language. Included on list rows; null if the persona was deleted.

persona objectnullable

Persona context, included on the single-session response (GET /sessions/{sessionId}) only — null if the persona was deleted.

iduuid

role_namestring

languagestring

system_promptstring

base_prompt_overridestringnullable

feedback objectnullable

Candidate post-interview survey, included on the single-session response (GET /sessions/{sessionId}) only — null if the candidate did not submit a survey.

ratinginteger

Possible values: >= 1 and <= 5

commentstringnullable

submitted_atdate-time

flaggedboolean

True when the rating is ≤ 2 (negative feedback).

SessionSummary

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "persona_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "candidate_ref": "string",
  "status": "initiated",
  "consent_mode": "explicit",
  "source": "requests",
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tags": [
    "string"
  ],
  "metadata": {},
  "started_at": "2024-07-29T15:51:28.071Z",
  "completed_at": "2024-07-29T15:51:28.071Z",
  "duration_sec": 0,
  "credit_charged": 0,
  "recording_s3_key": "string",
  "transcript_s3_key": "string",
  "interview_svc_session_id": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "role_name": "string",
  "language": "string",
  "persona": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role_name": "string",
    "language": "string",
    "system_prompt": "string",
    "base_prompt_override": "string"
  },
  "feedback": {
    "rating": 0,
    "comment": "string",
    "submitted_at": "2024-07-29T15:51:28.071Z",
    "flagged": true
  }
}