Skip to main content
POST
Create Interview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Body

application/json
workspace_id
string<uuid>
required
name
string
required
project_id
string<uuid> | null
description
string | null
goal
string | null
agent_behavior
string | null
channel
string
default:google_meet
completion_threshold
integer
default:90
timeframe_start
string<date-time> | null
timeframe_end
string<date-time> | null
interview_order
string
default:seniority_high_first
interview_duration_minutes
integer
default:30
timezone
string | null
start_immediately
boolean
default:true
scheduling_mode
string
default:availability
quick_mode_hours
integer | null
weekly_availability
Weekly Availability · object | null
project_context
string | null
success_criteria
string | null
interview_context_for_employee
string | null
interview_type
string | null
default:speaking_default
welcome_screen
string | null
closing_message
string | null
folder
string | null
recurring_interval
string | null

Response

Successful Response

id
string<uuid>
required
workspace_id
string<uuid>
required
project_id
string<uuid> | null
required
name
string
required
description
string | null
required
goal
string | null
required
agent_behavior
string | null
required
status
string
required
channel
string
required
completion_threshold
integer
required
timeframe_start
string<date-time> | null
required
timeframe_end
string<date-time> | null
required
interview_order
string
required
interview_duration_minutes
integer
required
created_by
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
timezone
string | null
start_immediately
boolean
default:true
scheduling_mode
string
default:availability
quick_mode_hours
integer | null
weekly_availability
Weekly Availability · object | null
project_context
string | null
success_criteria
string | null
interview_context_for_employee
string | null
interview_type
string | null
welcome_screen
string | null
closing_message
string | null
folder
string | null
recurring_interval
string | null
contact_count
integer
default:0
completed_count
integer
default:0
scheduled_count
integer
default:0