POST
/
create-session
curl --request POST \
  --url https://engine.diarupt.ai/create-session \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "face": "obama",
  "profile": "interviewer",
  "behavior": "Assume the role of a doctor. You'\''re conducting an examination.",
  "time_limit": 300,
  "context": "- Candidate Name is Jon. - Position is Software Engineer."
}'
{
  "session_id": "1234567890abcdef"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
Create Session options
​
face
string
required

AI Face for session, see /faces for available faces

Example:

"obama"

​
profile
string
required

AI Profile for session, see /profiles for available profiles

Example:

"interviewer"

​
behavior
string

AI behaviour extension of set profile for session

Example:

"Assume the role of a doctor. You're conducting an examination."

​
time_limit
number

Time limit for session in seconds, if 0 or not set then no time limit

Example:

300

​
context
string

Additonal context for session, builds on top of selected profile

Example:

"- Candidate Name is Jon. - Position is Software Engineer."

Response

201
application/json
Session created
​
session_id
string

Session ID

Example:

"1234567890abcdef"