latestOpenAPI 3.0.02026-08-19219210532.7 KB

bd5a5f406bca

role-play-session

Create a new role-play session

post/api/v1/role-play-sessions

Request body

missionIdstring required

MissionId defined by CMS.

overrideLanguage'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'pl' | 'zh' | 'ja' | 'id' | 'tr' | 'pt' | 'el' | 'ko' | 'vi' | 'hi' | 'ms' | 'th' | 'hr' | 'ro' | 'bg' | 'sv' | 'no' | 'yue'

Optional language override for the conversation. If not provided, defaults to the mission language.

Response

completedboolean required

createdAtstring date-time required

idstring required

language'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans' required

lastUpdatedAtstring date-time required

missionReferenceIdstring nullable

Reference ID for the associated mission

missionTitlestring nullable

playedLanguage'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'pl' | 'zh' | 'ja' | 'id' | 'tr' | 'pt' | 'el' | 'ko' | 'vi' | 'hi' | 'ms' | 'th' | 'hr' | 'ro' | 'bg' | 'sv' | 'no' | 'yue' | 'null' nullable

scorecardReferenceIdstring nullable

Reference ID for the associated scorecard

scorecardTitlestring nullable

Title of the associated scorecard

state'PENDING' | 'PROCESSING' | 'DONE' required

trackIdstring nullable

Parent track id for mission-backed roleplay sessions

trackTitlestring nullable

type'ROLE_PLAY' required

userIdstring required