Skip to main content
POST
/
api
/
v1
/
evaluation-templates
Create evaluation template
curl --request POST \
  --url https://www.intervyo.ai/api/v1/evaluation-templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "template_name": "<string>",
  "description": "<string>",
  "objective": "<string>",
  "domain": "<string>",
  "level": "<string>",
  "requirements": "<string>",
  "skills": [
    "<string>"
  ],
  "soft_skills": [
    "<string>"
  ],
  "additional_notes": "<string>",
  "default_duration_minutes": 123
}
'
{
  "error": "<string>",
  "issues": [
    {}
  ]
}

Authorizations

x-api-key
string
header
required

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

Body

application/json
template_name
string
required

Display name, e.g. "Senior Backend Engineer"

use_case
enum<string>
required

Determines recommendation vocabulary

Available options:
hiring,
admissions,
training,
custom_api
description
string
required

1–3 sentence overview of the role or program

objective
string
required

What the interview should determine

success_outcome
enum<string>

Outcome label (auto-derived from use_case if omitted)

Available options:
hire_no_hire,
admit_reject,
pass_fail,
ready_needs_training,
certified_not_certified,
custom
status
enum<string>

Default: active

Available options:
draft,
active,
archived
domain
string

Industry or field, e.g. "Software Engineering"

level
string

Seniority, e.g. "Senior / 5+ years"

requirements
string

What the candidate must demonstrate to pass

skills
string[]

Technical skills to probe, e.g. ["Go", "PostgreSQL"]

soft_skills
string[]

Behavioural traits, e.g. ["Communication", "Ownership"]

additional_notes
string

Context for the AI — company culture, edge cases, etc.

default_duration_minutes
integer

Default session length (default: 30)

default_difficulty
enum<string>

Default: intermediate

Available options:
beginner,
intermediate,
advanced,
expert,
adaptive
default_session_mode
enum<string>

Default: live_ai_interview

Available options:
live_ai_interview,
async_interview,
roleplay_simulation,
practice_session,
manual_review
visibility
enum<string>

Default: team

Available options:
private,
team,
organization,
public_template

Response

Success

Last modified on June 3, 2026