Skip to main content
POST
Create round

Authorizations

x-api-key
string
header
required

API key with the iv_live_ prefix. Create one under Developer → API Keys.

Body

application/json
role_id
string<uuid>
required

Parent Role

type
string
required

Stage type label, e.g. "technical"

interviewer
object
required

The AI interviewer for this round, created inline and linked atomically. Provide this OR interviewer_id.

stage_name
string

Display name shown to candidates

stage_type
enum<string>

Interview format — determines session_mode

Available options:
ai_interview,
roleplay_simulation,
practice_session,
manual_review,
async_assessment,
final_review
stage_order
integer

Position in pipeline (default: 0)

duration_minutes
integer

Session length in minutes (default: 30)

interviewer_id
string<uuid>

Link an EXISTING interviewer instead of creating one. Provide this OR the nested interviewer object.

difficulty
enum<string>

Default: intermediate

Available options:
beginner,
intermediate,
advanced,
expert,
adaptive
pass_threshold
number

Minimum score to pass

allow_retake
boolean

Allow retries on failure (default: false)

automation_rule
enum<string>

What happens automatically on completion (default: none)

Available options:
none,
auto_advance,
require_reviewer_approval
status
enum<string>

Default: active

Available options:
draft,
active,
archived

Response

Success

Last modified on July 26, 2026