Schedule session - intervyo.ai

curl --request POST \ --url https://www.intervyo.ai/api/v1/sessions \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' { "candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "evaluation_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "stage": "<string>", "interview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "idempotency_key": "<string>", "scheduled_at": "2023-11-07T05:31:56Z", "timezone": "<string>", "notes": "<string>", "force": true, "accountSlug": "<string>" } '

Authorizations

x-api-key

string

header

required

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

Body

application/json

candidate_id

string<uuid>

required

Participant to schedule

evaluation_template_id

string<uuid>

required

Evaluation template to use

stage

string

required

Stage label, e.g. "screen", "technical", "final"

interview_id

string<uuid>

Specific evaluation stage ID — auto-selected if omitted

idempotency_key

string

Unique key per request — returns the existing session if the key was already used

Maximum string length: 255

scheduled_at

string<date-time>

When to schedule the session

timezone

string

IANA timezone, e.g. America/New_York (default: UTC)

notes

string

Internal notes — not shown to the candidate

Maximum string length: 1000

force

boolean

Skip the duplicate-session check (default: false)

accountSlug

string

Team slug — required for session (cookie) auth

Response

Success