API docs by Redocly

Retorio API (1.0.0)

Download OpenAPI specification:Download

createOrUpdateBenchmarkProfileResults

Request Body schema: application/json
benchmarkProfileId
required
string

AI Profile ID

benchmarkMainId
required
string

AI Main ID

required
object or object

Benchmark profile results or error response

Responses

Request samples

Content type
application/json
{
  • "benchmarkProfileId": "string",
  • "benchmarkMainId": "string",
  • "results": {
    }
}

registerAnalysisResults

Request Body schema: application/json
analysisId
required
string

AI Analysis ID

required
object or object

Analysis results or error response

Responses

Request samples

Content type
application/json
{
  • "analysisId": "string",
  • "results": {
    }
}

createAiQaStep

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
Request Body schema: application/json
required
order
required
integer >= 0

Responses

Request samples

Content type
application/json
{
  • "order": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "order": 0,
  • "step": {
    }
}

updateAiQaStep

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
id
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
questionTranscript
required
string [ 1 .. 1000 ] characters
behavioralGoals
string or null [ 1 .. 1000 ] characters
Array of objects or null [ 1 .. 3 ] items
Array of objects or null [ 1 .. 3 ] items

Responses

Request samples

Content type
application/json
{
  • "questionTranscript": "string",
  • "behavioralGoals": "string",
  • "dos": [ ],
  • "donts": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "order": 0,
  • "step": {
    }
}

generateStepContent

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
id
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
field
required
string
Enum: "interlocutor_statement" "trainee_expected_behavior" "dos" "donts"

Responses

Request samples

Content type
application/json
{
  • "field": "interlocutor_statement"
}

Response samples

Content type
application/json
{
  • "field": "dos",
  • "suggestion": [
    ]
}

createWinningBehaviorRealtime

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
Request Body schema: application/json
required
description
required
string [ 1 .. 255 ] characters
behaviorType
required
string
Enum: "positive" "negative"
skillName
required
string [ 1 .. 255 ] characters
missionStageOrder
required
integer [ 0 .. 2 ]

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "behaviorType": "positive",
  • "skillName": "string",
  • "missionStageOrder": 2
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "description": "string",
  • "behaviorType": "positive",
  • "skill": {
    }
}

updateWinningBehaviorRealtime

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
description
required
string [ 1 .. 255 ] characters
behaviorType
required
string
Enum: "positive" "negative"
skillName
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "behaviorType": "positive",
  • "skillName": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "description": "string",
  • "behaviorType": "positive",
  • "skill": {
    }
}

deleteWinningBehaviorRealtime

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

generateScenarioContentForAiSupportedScenario

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
Request Body schema: application/json
required
field
required
string
Enum: "learning_goal" "scenario_description"
tone
required
string
Enum: "professional" "catchy"

Responses

Request samples

Content type
application/json
{
  • "field": "learning_goal",
  • "tone": "professional"
}

Response samples

Content type
application/json
{
  • "field": "learning_goal",
  • "tone": "professional",
  • "suggestion": "string"
}

generateScenarioContentForRealtimeScenario

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
field
required
string
Enum: "learning_goal" "scenario_description"
tone
required
string
Enum: "professional" "catchy"

Responses

Request samples

Content type
application/json
{
  • "field": "learning_goal",
  • "tone": "professional"
}

Response samples

Content type
application/json
{
  • "field": "learning_goal",
  • "tone": "professional",
  • "suggestion": "string"
}

createInstruction

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
Request Body schema: application/json
required
description
required
string [ 1 .. 255 ] characters
behaviorType
required
string
Enum: "positive" "negative"
how
string or null [ 1 .. 500 ] characters
skillName
required
string [ 1 .. 255 ] characters
missionStageOrder
required
integer [ 0 .. 2 ]

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "behaviorType": "positive",
  • "how": "string",
  • "skillName": "string",
  • "missionStageOrder": 2
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "description": "string",
  • "behaviorType": "positive",
  • "skill": {
    },
  • "how": "string"
}

updateInstruction

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
description
required
string [ 1 .. 255 ] characters
behaviorType
required
string
Enum: "positive" "negative"
how
string or null [ 1 .. 500 ] characters
skillName
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "behaviorType": "positive",
  • "how": "string",
  • "skillName": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "description": "string",
  • "behaviorType": "positive",
  • "skill": {
    },
  • "how": "string"
}

deleteInstruction

path Parameters
programExtId
required
string
trainingExtId
required
string
scenarioExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

getScenarioByExtId

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "type": "manual",
  • "order": 0,
  • "durationInMinutes": 0,
  • "title": "string",
  • "description": "string",
  • "furtherDetails": "string",
  • "goal": "string",
  • "interlocutorRole": "string",
  • "traineeRole": "string",
  • "degreeOfRelationship": "string",
  • "thumbnailImgUrl": "string",
  • "missionGoal": "string",
  • "personaOpeningStatement": "string",
  • "finalPersonaAttitude": "string",
  • "winningBehavior": {
    },
  • "persona": {
    },
  • "trainee": {
    },
  • "missionStages": [
    ],
  • "editable": true,
  • "hasRecordingSessions": true
}

deleteScenarioByExtId

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

createScenario

path Parameters
programExtId
required
string
trainingExtId
required
string
Request Body schema: application/json
required
type
required
string (scenarioType)
Enum: "manual" "aiSupported" "realtime" "realtimeBuilder"

Responses

Request samples

Content type
application/json
{
  • "type": "manual"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "type": "manual",
  • "order": 0,
  • "durationInMinutes": 0,
  • "title": "string",
  • "description": "string",
  • "furtherDetails": "string",
  • "goal": "string",
  • "interlocutorRole": "string",
  • "traineeRole": "string",
  • "degreeOfRelationship": "string",
  • "thumbnailImgUrl": "string",
  • "missionGoal": "string",
  • "personaOpeningStatement": "string",
  • "finalPersonaAttitude": "string",
  • "winningBehavior": {
    },
  • "persona": {
    },
  • "trainee": {
    },
  • "missionStages": [
    ],
  • "editable": true,
  • "hasRecordingSessions": true
}

getScenarios

path Parameters
programExtId
required
string
trainingExtId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateScenarioDetails

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
title
string or null [ 1 .. 255 ] characters
goal
string or null [ 1 .. 1000 ] characters
description
string or null [ 1 .. 10000 ] characters
traineeRole
string or null [ 1 .. 255 ] characters
degreeOfRelationship
string or null [ 1 .. 255 ] characters
interlocutorRole
string or null [ 1 .. 255 ] characters
furtherDetails
string or null [ 1 .. 10000 ] characters
missionGoal
string or null [ 1 .. 125 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "goal": "string",
  • "description": "string",
  • "traineeRole": "string",
  • "degreeOfRelationship": "string",
  • "interlocutorRole": "string",
  • "furtherDetails": "string",
  • "missionGoal": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "type": "manual",
  • "order": 0,
  • "durationInMinutes": 0,
  • "title": "string",
  • "description": "string",
  • "furtherDetails": "string",
  • "goal": "string",
  • "interlocutorRole": "string",
  • "traineeRole": "string",
  • "degreeOfRelationship": "string",
  • "thumbnailImgUrl": "string",
  • "missionGoal": "string",
  • "personaOpeningStatement": "string",
  • "finalPersonaAttitude": "string",
  • "winningBehavior": {
    },
  • "persona": {
    },
  • "trainee": {
    },
  • "missionStages": [
    ],
  • "editable": true,
  • "hasRecordingSessions": true
}

updateScenarioAtGoalStep

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
One of
furtherDetails
string or null [ 1 .. 10000 ] characters
winningBehaviorType
required
string
Value: "custom"
title
required
string [ 1 .. 255 ] characters
goodExamples
required
string [ 1 .. 10000 ] characters
badExamples
string or null [ 1 .. 10000 ] characters
description
required
string [ 1 .. 10000 ] characters

Responses

Request samples

Content type
application/json
{
  • "furtherDetails": "string",
  • "winningBehaviorType": "template",
  • "winningBehaviorExtId": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "type": "manual",
  • "order": 0,
  • "durationInMinutes": 0,
  • "title": "string",
  • "description": "string",
  • "furtherDetails": "string",
  • "goal": "string",
  • "interlocutorRole": "string",
  • "traineeRole": "string",
  • "degreeOfRelationship": "string",
  • "thumbnailImgUrl": "string",
  • "missionGoal": "string",
  • "personaOpeningStatement": "string",
  • "finalPersonaAttitude": "string",
  • "winningBehavior": {
    },
  • "persona": {
    },
  • "trainee": {
    },
  • "missionStages": [
    ],
  • "editable": true,
  • "hasRecordingSessions": true
}

reorderScenarios

path Parameters
programExtId
required
string
trainingExtId
required
string
Request Body schema: application/json
required
Array (non-empty)
extId
required
string [ 1 .. 255 ] characters
order
required
integer >= 0

Responses

Request samples

Content type
application/json
[
  • {
    }
]

selectPersona

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
personaExtId
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "personaExtId": "string"
}

getPersonas

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

selectTrainee

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
traineeExtId
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "traineeExtId": "string"
}

getTrainees

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

startVideoGenerations

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters

Responses

updateVideoGenerationData

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
stepExtIds
required
Array of strings non-empty [ items [ 1 .. 255 ] characters ]

Responses

Request samples

Content type
application/json
{
  • "stepExtIds": [
    ]
}

saveStageGoals

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
stageGoals
required
Array of strings[ items [ 1 .. 125 ] characters ]

Responses

Request samples

Content type
application/json
{
  • "stageGoals": [
    ]
}

saveBehavioralAttitudes

path Parameters
programExtId
required
string
trainingExtId
required
string
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
finalPersonaAttitude
string or null [ 1 .. 1000 ] characters
personaOpeningStatement
required
string [ 1 .. 10000 ] characters
required
object

Responses

Request samples

Content type
application/json
{
  • "finalPersonaAttitude": "string",
  • "personaOpeningStatement": "string",
  • "personaAttitudes": {
    }
}

reorderTrainings

path Parameters
programExtId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
Array (non-empty)
extId
required
string [ 1 .. 255 ] characters
order
required
integer >= 0

Responses

Request samples

Content type
application/json
[
  • {
    }
]

getTrainings

path Parameters
programExtId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createTraining

path Parameters
programExtId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters
description
string or null [ 1 .. 1000 ] characters
order
required
integer >= 0

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string"
}

getTrainingByExtId

path Parameters
programExtId
required
string [ 1 .. 255 ] characters
extId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string"
}

updateTraining

path Parameters
programExtId
required
string [ 1 .. 255 ] characters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters
description
string or null [ 1 .. 1000 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string"
}

deleteTraining

path Parameters
programExtId
required
string [ 1 .. 255 ] characters
extId
required
string [ 1 .. 255 ] characters

Responses

getAllPrograms

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createProgram

Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters
description
string or null [ 1 .. 1000 ] characters
language
required
string (languageEnum)
Enum: "en-US" "fr-FR" "de-DE" "es-ES" "it-IT" "pt-PT"
imageUrl
string or null [ 1 .. 1000 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string",
  • "understandingEnabled": true,
  • "status": "unpublished"
}

getSharedPrograms

Responses

Response samples

Content type
application/json
[
  • {
    }
]

acceptSharedProgram

path Parameters
sharedExtId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "receiverEmail": "string",
  • "status": "pending"
}

rejectSharedProgram

path Parameters
sharedExtId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "receiverEmail": "string",
  • "status": "pending"
}

getProgramByExtId

path Parameters
extId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string",
  • "understandingEnabled": true,
  • "status": "unpublished",
  • "hasRegisteredCoachingUsers": true,
  • "hasBreakingChanges": true
}

updateProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters
description
string or null [ 1 .. 1000 ] characters
imageUrl
string or null [ 1 .. 1000 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "imageUrl": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string",
  • "understandingEnabled": true,
  • "status": "unpublished"
}

deleteProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters

Responses

publishProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
shouldNotify
required
boolean

Responses

Request samples

Content type
application/json
{
  • "shouldNotify": true
}

cloneProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string",
  • "understandingEnabled": true,
  • "status": "unpublished"
}

unpublishProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters

Responses

shareProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
email
required
string <email> [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "receiverEmail": "string",
  • "status": "pending"
}

deleteSharedProgram

path Parameters
extId
required
string [ 1 .. 255 ] characters
sharedExtId
required
string [ 1 .. 255 ] characters

Responses

getExercises

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createExercise

Request Body schema: application/json
required
programExtIds
Array of strings or null
required
object (createExerciseData)

Responses

Request samples

Content type
application/json
{
  • "programExtIds": [
    ],
  • "exerciseData": {
    }
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string",
  • "type": "facialExpressions",
  • "shortDescription": "string",
  • "execution": "string",
  • "durationInMinutes": 1,
  • "preparationItems": [
    ]
}

updateExercise

path Parameters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters
description
required
string [ 1 .. 10000 ] characters
imageUrl
required
string [ 1 .. 1000 ] characters
language
required
string (languageEnum)
Enum: "en-US" "fr-FR" "de-DE" "es-ES" "it-IT" "pt-PT"
durationInMinutes
required
integer [ 1 .. 300 ]
execution
required
string [ 1 .. 10000 ] characters
required
Array of objects [ 1 .. 6 ] items
shortDescription
required
string [ 1 .. 1000 ] characters
type
required
string (exerciseType)
Enum: "facialExpressions" "speakingSpeed" "understandability" "pauses" "socialFocus" "positiveLanguage" "sentenceLength" "adjectives"

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "imageUrl": "string",
  • "language": "en-US",
  • "durationInMinutes": 1,
  • "execution": "string",
  • "preparationItems": [
    ],
  • "shortDescription": "string",
  • "type": "facialExpressions"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "title": "string",
  • "description": "string",
  • "language": "en-US",
  • "imageUrl": "string",
  • "type": "facialExpressions",
  • "shortDescription": "string",
  • "execution": "string",
  • "durationInMinutes": 1,
  • "preparationItems": [
    ]
}

deleteExercise

path Parameters
extId
required
string [ 1 .. 255 ] characters

Responses

updateConnectedProgramsOfExercise

path Parameters
extId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
programExtIds
required
Array of strings[ items [ 1 .. 255 ] characters ]

Responses

Request samples

Content type
application/json
{
  • "programExtIds": [
    ]
}

createProgramUsingTemplate

path Parameters
extId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
"string"

getAllProgramTemplates

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getWinningBehaviorTemplates

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAvatarsAndVoices

query Parameters
language
required
string (languageEnum)
Enum: "en-US" "fr-FR" "de-DE" "es-ES" "it-IT" "pt-PT"

Responses

Response samples

Content type
application/json
{
  • "avatars": [
    ],
  • "voices": [
    ]
}

createPersona

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
age
string or null
Enum: "youngAdult" "adult" "olderAdult"
attitude
required
string
Enum: "positive" "neutral" "negative"
industry
string or null [ 1 .. 255 ] characters
jobRole
string or null [ 1 .. 255 ] characters
conversationContext
required
string
Enum: "b2c" "b2b" "internal"
manners
string or null [ 1 .. 10000 ] characters
needsAndPains
string or null [ 1 .. 5000 ] characters
goals
string or null [ 1 .. 5000 ] characters
personality
required
string [ 1 .. 255 ] characters
personalValues
required
string [ 1 .. 255 ] characters
sex
required
string
Enum: "male" "female"
backgroundUrl
string or null [ 1 .. 1000 ] characters
videoGenerationAvatarExtId
required
string
videoGenerationVoiceExtId
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "age": "youngAdult",
  • "attitude": "positive",
  • "industry": "string",
  • "jobRole": "string",
  • "conversationContext": "b2c",
  • "manners": "string",
  • "needsAndPains": "string",
  • "goals": "string",
  • "personality": "string",
  • "personalValues": "string",
  • "sex": "male",
  • "backgroundUrl": "string",
  • "videoGenerationAvatarExtId": "string",
  • "videoGenerationVoiceExtId": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "name": "string",
  • "age": "youngAdult",
  • "attitude": "positive",
  • "industry": "string",
  • "jobRole": "string",
  • "conversationContext": "b2c",
  • "manners": "string",
  • "needsAndPains": "string",
  • "goals": "string",
  • "personality": "string",
  • "personalValues": "string",
  • "sex": "male",
  • "backgroundUrl": "string",
  • "language": "string",
  • "type": "template",
  • "videoGenerationVoice": {
    },
  • "videoGenerationAvatar": {
    },
  • "firstVersionExtId": "string",
  • "nextVersionExtId": "string"
}

updatePersona

path Parameters
personaExtId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
age
string or null
Enum: "youngAdult" "adult" "olderAdult"
attitude
required
string
Enum: "positive" "neutral" "negative"
industry
string or null [ 1 .. 255 ] characters
jobRole
string or null [ 1 .. 255 ] characters
conversationContext
required
string
Enum: "b2c" "b2b" "internal"
manners
string or null [ 1 .. 10000 ] characters
needsAndPains
string or null [ 1 .. 5000 ] characters
goals
string or null [ 1 .. 5000 ] characters
personality
required
string [ 1 .. 255 ] characters
personalValues
required
string [ 1 .. 255 ] characters
sex
required
string
Enum: "male" "female"
backgroundUrl
string or null [ 1 .. 1000 ] characters
videoGenerationAvatarExtId
required
string
videoGenerationVoiceExtId
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "age": "youngAdult",
  • "attitude": "positive",
  • "industry": "string",
  • "jobRole": "string",
  • "conversationContext": "b2c",
  • "manners": "string",
  • "needsAndPains": "string",
  • "goals": "string",
  • "personality": "string",
  • "personalValues": "string",
  • "sex": "male",
  • "backgroundUrl": "string",
  • "videoGenerationAvatarExtId": "string",
  • "videoGenerationVoiceExtId": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "name": "string",
  • "age": "youngAdult",
  • "attitude": "positive",
  • "industry": "string",
  • "jobRole": "string",
  • "conversationContext": "b2c",
  • "manners": "string",
  • "needsAndPains": "string",
  • "goals": "string",
  • "personality": "string",
  • "personalValues": "string",
  • "sex": "male",
  • "backgroundUrl": "string",
  • "language": "string",
  • "type": "template",
  • "videoGenerationVoice": {
    },
  • "videoGenerationAvatar": {
    },
  • "firstVersionExtId": "string",
  • "nextVersionExtId": "string"
}

deletePersona

path Parameters
personaExtId
required
string [ 1 .. 255 ] characters

Responses

duplicatePersona

path Parameters
personaExtId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "name": "string",
  • "age": "youngAdult",
  • "attitude": "positive",
  • "industry": "string",
  • "jobRole": "string",
  • "conversationContext": "b2c",
  • "manners": "string",
  • "needsAndPains": "string",
  • "goals": "string",
  • "personality": "string",
  • "personalValues": "string",
  • "sex": "male",
  • "backgroundUrl": "string",
  • "language": "string",
  • "type": "template",
  • "videoGenerationVoice": {
    },
  • "videoGenerationAvatar": {
    },
  • "firstVersionExtId": "string",
  • "nextVersionExtId": "string"
}

createTrainee

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
jobRole
required
string [ 1 .. 255 ] characters
hierarchy
required
string
Enum: "low" "mid" "high"
hasLeadershipResponsibility
required
boolean
industry
required
string [ 1 .. 255 ] characters
department
required
string [ 1 .. 255 ] characters
workplace
string or null
Enum: "hybrid" "remote" "onSite"
seniority
required
string
Enum: "low" "mid" "high" "veryHigh"
imageUrl
string or null [ 1 .. 1000 ] characters
language
required
string (languageEnum)
Enum: "en-US" "fr-FR" "de-DE" "es-ES" "it-IT" "pt-PT"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "jobRole": "string",
  • "hierarchy": "low",
  • "hasLeadershipResponsibility": true,
  • "industry": "string",
  • "department": "string",
  • "workplace": "hybrid",
  • "seniority": "low",
  • "imageUrl": "string",
  • "language": "en-US"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "name": "string",
  • "jobRole": "string",
  • "hierarchy": "low",
  • "hasLeadershipResponsibility": true,
  • "industry": "string",
  • "department": "string",
  • "workplace": "hybrid",
  • "seniority": "low",
  • "imageUrl": "string",
  • "language": "string",
  • "type": "template",
  • "firstVersionExtId": "string",
  • "nextVersionExtId": "string"
}

updateTrainee

path Parameters
traineeExtId
required
string [ 1 .. 255 ] characters
Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
jobRole
required
string [ 1 .. 255 ] characters
hierarchy
required
string
Enum: "low" "mid" "high"
hasLeadershipResponsibility
required
boolean
industry
required
string [ 1 .. 255 ] characters
department
required
string [ 1 .. 255 ] characters
workplace
string or null
Enum: "hybrid" "remote" "onSite"
seniority
required
string
Enum: "low" "mid" "high" "veryHigh"
imageUrl
string or null [ 1 .. 1000 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "jobRole": "string",
  • "hierarchy": "low",
  • "hasLeadershipResponsibility": true,
  • "industry": "string",
  • "department": "string",
  • "workplace": "hybrid",
  • "seniority": "low",
  • "imageUrl": "string"
}

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "name": "string",
  • "jobRole": "string",
  • "hierarchy": "low",
  • "hasLeadershipResponsibility": true,
  • "industry": "string",
  • "department": "string",
  • "workplace": "hybrid",
  • "seniority": "low",
  • "imageUrl": "string",
  • "language": "string",
  • "type": "template",
  • "firstVersionExtId": "string",
  • "nextVersionExtId": "string"
}

deleteTrainee

path Parameters
traineeExtId
required
string [ 1 .. 255 ] characters

Responses

duplicateTrainee

path Parameters
traineeExtId
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/json
{
  • "extId": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "name": "string",
  • "jobRole": "string",
  • "hierarchy": "low",
  • "hasLeadershipResponsibility": true,
  • "industry": "string",
  • "department": "string",
  • "workplace": "hybrid",
  • "seniority": "low",
  • "imageUrl": "string",
  • "language": "string",
  • "type": "template",
  • "firstVersionExtId": "string",
  • "nextVersionExtId": "string"
}

getSkills

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createFeedbackForRecording

Request Body schema: application/json
customFeedback
string or null [ 1 .. 255 ] characters

user customFeedback

selectedOption
required
string
Enum: "acceptedAnswer" "rejectedAnswer" "other"

user selectedOption

Responses

Request samples

Content type
application/json
{
  • "customFeedback": "string",
  • "selectedOption": "acceptedAnswer"
}

getUserInfo

Responses

createActiveSession

Request Body schema: application/json
required
userExtId
required
string
aiHeraAllocationSessionId
required
string
aiMissionId
required
string
aiSessionId
required
string
aiStateId
required
string

Responses

Request samples

Content type
application/json
{
  • "userExtId": "string",
  • "aiHeraAllocationSessionId": "string",
  • "aiMissionId": "string",
  • "aiSessionId": "string",
  • "aiStateId": "string"
}

updateActiveSession

Request Body schema: application/json
required
userExtId
required
string
aiLastStateId
string
aiHeraAllocationSessionId
required
string
state
string
Value: "SUSPENDED"

Responses

Request samples

Content type
application/json
{
  • "userExtId": "string",
  • "aiLastStateId": "string",
  • "aiHeraAllocationSessionId": "string",
  • "state": "SUSPENDED"
}

cleanUpInactiveSessions

Responses