Skip to main content
POST
/
v1
/
interviews
/
{interview_id}
/
start
Start Interview
curl --request POST \
  --url https://api.ontora.com/v1/interviews/{interview_id}/start \
  --header 'Authorization: Bearer <token>'
{
  "interview": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "goal": "<string>",
    "agent_behavior": "<string>",
    "status": "<string>",
    "channel": "<string>",
    "completion_threshold": 123,
    "timeframe_start": "2023-11-07T05:31:56Z",
    "timeframe_end": "2023-11-07T05:31:56Z",
    "interview_order": "<string>",
    "interview_duration_minutes": 123,
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "start_immediately": true,
    "scheduling_mode": "availability",
    "quick_mode_hours": 123,
    "weekly_availability": {},
    "project_context": "<string>",
    "success_criteria": "<string>",
    "interview_context_for_employee": "<string>",
    "interview_type": "<string>",
    "welcome_screen": "<string>",
    "closing_message": "<string>",
    "folder": "<string>",
    "recurring_interval": "<string>",
    "contact_count": 0,
    "completed_count": 0,
    "scheduled_count": 0
  },
  "scheduled_count": 123,
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ontora.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Path Parameters

interview_id
string<uuid>
required

Response

Successful Response

interview
InterviewOut · object
required
scheduled_count
integer
required
message
string
required