Skip to main content
POST
/
api
/
v1
/
agent-profiles
Create or fork an agent profile
curl --request POST \
  --url https://www.intervyo.ai/api/v1/agent-profiles \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "persona": "<string>",
  "evaluationDimensions": [
    {}
  ],
  "context": {},
  "interaction": {},
  "scoring": {},
  "output": {},
  "additionalInstructions": "<string>",
  "isPublic": true
}
'
{
  "error": "<string>",
  "issues": [
    {}
  ]
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

action
string

Set to "fork" to fork a public profile instead of creating a new one

Body

application/json
name
string
required

Display name, e.g. "Senior Engineering Interviewer"

persona
string
required

How the AI introduces itself at the start of a session

useCase
enum<string>
required

Determines recommendation vocabulary

Available options:
hiring,
admissions,
training,
custom_api
evaluationDimensions
object[]
required

[{ name, description, weight }] — weights must sum to 100

context
object

{ organizationContext?, domainContext?, scenarioContext? }

interaction
object

{ tone?: friendly|professional|strict|challenging, style?: structured|conversational|adaptive, difficulty?: easy|medium|hard|adaptive, probingDepth?: low|medium|high }

scoring
object

{ scale?: 0-10|0-5|0-100, scoringMethod?: weighted_average|rule_based, recommendationLogic? }

output
object

{ includeTranscript?, includeScoreBreakdown?, includeRecommendation?, includeImprovementFeedback? } — all default to true

additionalInstructions
string

Edge cases, constraints, or tone overrides for this agent

isPublic
boolean

Publish to the shared library (default: false)

Response

Success

Last modified on June 2, 2026