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

Payload

Content type

application/json

{"benchmarkProfileId": "string",
"benchmarkMainId": "string",
"results": {"profile": {"profile_id": "string",
"version": "string",
"description": "string",
"main_id": "string",
"parent_id": "string",
"created_at": "string",
"is_active": true,
"is_current": true,
"environment": "string",
"analyses": [null
],
"features": { }
}
}
}

registerAnalysisResults

Request Body schema: application/json

analysisId required	string AI Analysis ID
required	object or object Analysis results or error response

Responses

Request samples

Payload

Content type

application/json

{"analysisId": "string",
"results": {"id": "string",
"metadata": {"analysis_created": "string",
"language": "string",
"video_uploaded": "string",
"analysis_started": "string",
"analysis_finished": "string",
"video_duration": 0,
"video_size": 0
},
"predictions": [null
]
}
}

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

Payload

Content type

application/json

{"order": 0
}

Response samples

200

Content type

application/json

{"id": "string",
"createdAt": "string",
"updatedAt": "string",
"order": 0,
"step": {"id": "string",
"createdAt": "string",
"updatedAt": "string",
"type": "aiSupported",
"stepType": "coachingStepQA",
"questionTranscript": "string",
"behavioralGoals": "string",
"dos": [ ],
"donts": [ ],
"maxRecordingTime": 0,
"questionVideoGenerationData": {"extId": "string",
"videoUrl": "string",
"errorPayload": null,
"status": "init"
},
"answerVideoGenerationData": {"extId": "string",
"videoUrl": "string",
"errorPayload": null,
"status": "init"
},
"isVideoGenerationDataChanged": true
}
}

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

Payload

Content type

application/json

{"questionTranscript": "string",
"behavioralGoals": "string",
"dos": [ ],
"donts": [ ]
}

Response samples

200

Content type

application/json

{"id": "string",
"createdAt": "string",
"updatedAt": "string",
"order": 0,
"step": {"id": "string",
"createdAt": "string",
"updatedAt": "string",
"type": "aiSupported",
"stepType": "coachingStepQA",
"questionTranscript": "string",
"behavioralGoals": "string",
"dos": [ ],
"donts": [ ],
"maxRecordingTime": 0,
"questionVideoGenerationData": {"extId": "string",
"videoUrl": "string",
"errorPayload": null,
"status": "init"
},
"answerVideoGenerationData": {"extId": "string",
"videoUrl": "string",
"errorPayload": null,
"status": "init"
},
"isVideoGenerationDataChanged": true
}
}

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

Payload

Content type

application/json

{"field": "interlocutor_statement"
}

Response samples

200

Content type

application/json

{"field": "dos",
"suggestion": ["string"
]
}

getScenarioByExtId

path Parameters

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

Responses

Response samples

200

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",
"winningBehavior": {"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"isTemplate": true,
"winningBehaviorsCustom": {"title": "string",
"goodExamples": "string",
"badExamples": "string",
"description": "string"
},
"winningBehaviorsTemplates": {"skill": "string",
"tactic": "string"
}
},
"persona": {"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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"firstVersionExtId": "string",
"nextVersionExtId": "string"
},
"trainee": {"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"
},
"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

Payload

Content type

application/json

{"type": "manual"
}

Response samples

200

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",
"winningBehavior": {"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"isTemplate": true,
"winningBehaviorsCustom": {"title": "string",
"goodExamples": "string",
"badExamples": "string",
"description": "string"
},
"winningBehaviorsTemplates": {"skill": "string",
"tactic": "string"
}
},
"persona": {"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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"firstVersionExtId": "string",
"nextVersionExtId": "string"
},
"trainee": {"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"
},
"editable": true,
"hasRecordingSessions": true
}

getScenarios

path Parameters

programExtId required	string
trainingExtId required	string

Responses

Response samples

200

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",
"winningBehavior": {"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"isTemplate": true,
"winningBehaviorsCustom": {"title": "string",
"goodExamples": "string",
"badExamples": "string",
"description": "string"
},
"winningBehaviorsTemplates": {"skill": "string",
"tactic": "string"
}
},
"persona": {"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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"firstVersionExtId": "string",
"nextVersionExtId": "string"
},
"trainee": {"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"
},
"editable": true,
"hasRecordingSessions": true
}
]

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

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"goal": "string",
"description": "string",
"traineeRole": "string",
"degreeOfRelationship": "string",
"interlocutorRole": "string"
}

Response samples

200

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",
"winningBehavior": {"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"isTemplate": true,
"winningBehaviorsCustom": {"title": "string",
"goodExamples": "string",
"badExamples": "string",
"description": "string"
},
"winningBehaviorsTemplates": {"skill": "string",
"tactic": "string"
}
},
"persona": {"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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"firstVersionExtId": "string",
"nextVersionExtId": "string"
},
"trainee": {"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"
},
"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

Payload

Content type

application/json

{"furtherDetails": "string",
"winningBehaviorType": "template",
"winningBehaviorExtId": "string"
}

Response samples

200

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",
"winningBehavior": {"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"isTemplate": true,
"winningBehaviorsCustom": {"title": "string",
"goodExamples": "string",
"badExamples": "string",
"description": "string"
},
"winningBehaviorsTemplates": {"skill": "string",
"tactic": "string"
}
},
"persona": {"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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"firstVersionExtId": "string",
"nextVersionExtId": "string"
},
"trainee": {"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"
},
"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

Payload

Content type

application/json

[{"extId": "string",
"order": 0
}
]

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

Payload

Content type

application/json

{"personaExtId": "string"
}

getPersonas

path Parameters

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

Responses

Response samples

200

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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"firstVersionExtId": "string",
"nextVersionExtId": "string",
"scenariosAttached": 0,
"editable": true
}
]

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

Payload

Content type

application/json

{"traineeExtId": "string"
}

getTrainees

path Parameters

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

Responses

Response samples

200

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",
"scenariosAttached": 0,
"editable": true
}
]

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

Payload

Content type

application/json

{"stepExtIds": ["string"
]
}

generateScenarioContent

path Parameters

programExtId required	string
trainingExtId 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

Payload

Content type

application/json

{"field": "learning_goal",
"tone": "professional"
}

Response samples

200

Content type

application/json

{"field": "learning_goal",
"tone": "professional",
"suggestion": "string"
}

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

Payload

Content type

application/json

[{"extId": "string",
"order": 0
}
]

getTrainings

path Parameters

programExtId

required

string [ 1 .. 255 ] characters

Responses

Response samples

200

Content type

application/json

[{"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"title": "string",
"description": "string",
"scenariosCount": 0
}
]

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

Payload

Content type

application/json

{"title": "string",
"description": "string",
"order": 0
}

Response samples

200

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

200

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

Payload

Content type

application/json

{"title": "string",
"description": "string"
}

Response samples

200

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

200

Content type

application/json

[{"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"title": "string",
"description": "string",
"language": "en-US",
"imageUrl": "string",
"understandingEnabled": true,
"status": "unpublished",
"trainingsCount": 0,
"hasRecordingSessions": true,
"hasRegisteredCoachingUsers": true,
"hasBreakingChanges": true,
"sharedPrograms": [{"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"receiverEmail": "string",
"status": "pending"
}
]
}
]

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

Payload

Content type

application/json

{"title": "string",
"description": "string",
"language": "en-US",
"imageUrl": "string"
}

Response samples

200

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

200

Content type

application/json

[{"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"receiverEmail": "string",
"status": "pending",
"senderEmail": "string"
}
]

acceptSharedProgram

path Parameters

sharedExtId

required

string [ 1 .. 255 ] characters

Responses

Response samples

200

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

200

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

200

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

Payload

Content type

application/json

{"title": "string",
"description": "string",
"imageUrl": "string"
}

Response samples

200

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

Payload

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

Payload

Content type

application/json

{"title": "string"
}

Response samples

200

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

Payload

Content type

application/json

{"email": "user@example.com"
}

Response samples

200

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

200

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": [{"text": "string"
}
],
"programExtIds": ["string"
]
}
]

createExercise

Request Body schema: application/json
required

programExtIds	Array of strings or null
required	object (createExerciseData)

Responses

Request samples

Payload

Content type

application/json

{"programExtIds": ["string"
],
"exerciseData": {"title": "string",
"description": "string",
"imageUrl": "string",
"language": "en-US",
"durationInMinutes": 1,
"execution": "string",
"preparationItems": [{"text": "string"
}
],
"shortDescription": "string",
"type": "facialExpressions"
}
}

Response samples

200

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": [{"text": "string"
}
]
}

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

Payload

Content type

application/json

{"title": "string",
"description": "string",
"imageUrl": "string",
"language": "en-US",
"durationInMinutes": 1,
"execution": "string",
"preparationItems": [{"text": "string"
}
],
"shortDescription": "string",
"type": "facialExpressions"
}

Response samples

200

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": [{"text": "string"
}
]
}

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

Payload

Content type

application/json

{"programExtIds": ["string"
]
}

createProgramUsingTemplate

path Parameters

extId

required

string [ 1 .. 255 ] characters

Responses

Response samples

200

Content type

application/json

"string"

getAllProgramTemplates

Responses

Response samples

200

Content type

application/json

[{"extId": "string",
"createdAt": "string",
"program": {"extId": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"language": "en-US",
"trainings": [{"title": "string",
"extId": "string",
"scenarios": [{"title": "string",
"durationInMinutes": 0,
"extId": "string",
"description": "string",
"persona": {"backgroundUrl": "string",
"videoGenerationAvatar": {"imageUrl": "string"
}
}
}
]
}
]
},
"departments": ["string"
],
"useCases": ["string"
],
"industries": ["string"
],
"submittedSessionsCount": 0,
"tag": "new"
}
]

getWinningBehaviorTemplates

Responses

Response samples

200

Content type

application/json

[{"extId": "string",
"createdAt": "string",
"updatedAt": "string",
"isTemplate": true,
"winningBehaviorsCustom": {"title": "string",
"goodExamples": "string",
"badExamples": "string",
"description": "string"
},
"winningBehaviorsTemplates": {"skill": "string",
"tactic": "string"
}
}
]

getAvatarsAndVoices

query Parameters

language

required

string (languageEnum)

Enum: "en-US" "fr-FR" "de-DE" "es-ES" "it-IT" "pt-PT"

Responses

Response samples

200

Content type

application/json

{"avatars": [{"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
}
],
"voices": [{"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
}
]
}

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 .. 10000 ] characters
goals	string or null [ 1 .. 10000 ] 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

Payload

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

200

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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"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 .. 10000 ] characters
goals	string or null [ 1 .. 10000 ] 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

Payload

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

200

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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"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

200

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": {"extId": "string",
"gender": "string",
"name": "string",
"previewUrl": "string",
"labelKey": "string"
},
"videoGenerationAvatar": {"extId": "string",
"gender": "string",
"imageUrl": "string",
"previewUrl": "string",
"thumbnailUrl": "string",
"name": "string"
},
"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

Payload

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

200

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

Payload

Content type

application/json

{"name": "string",
"jobRole": "string",
"hierarchy": "low",
"hasLeadershipResponsibility": true,
"industry": "string",
"department": "string",
"workplace": "hybrid",
"seniority": "low",
"imageUrl": "string"
}

Response samples

200

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

200

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"
}

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

Payload

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

Payload

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

Payload

Content type

application/json

{"userExtId": "string",
"aiLastStateId": "string",
"aiHeraAllocationSessionId": "string",
"state": "SUSPENDED"
}

Retorio API (1.0.0)

createOrUpdateBenchmarkProfileResults

Request Body schema: application/json

Responses

Request samples

registerAnalysisResults

Request Body schema: application/json

Responses

Request samples

createAiQaStep

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

updateAiQaStep

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

generateStepContent

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getScenarioByExtId

path Parameters

Responses

Response samples

deleteScenarioByExtId

path Parameters

Responses

createScenario

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getScenarios

path Parameters

Responses

Response samples

updateScenarioDetails

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

updateScenarioAtGoalStep

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

reorderScenarios

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

selectPersona

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

getPersonas

path Parameters

Responses

Response samples

selectTrainee

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

getTrainees

path Parameters

Responses

Response samples

startVideoGenerations

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required