EndpointsCoaching Sessions
Create coaching session
POST
/v2/coaching-sessionsStarts a coaching session over one episode replay and returns the presigned upload for its recording. A coached policy must be seated in the episode and owned by the caller.
Authorization
BearerAuth AuthorizationBearer <token>
Bearer token issued by Softmax
In: header
Request Body
application/json
idempotency_key*Idempotency Key
Caller-chosen key; a retry with the same key returns the original instead of creating another.
Length
1 <= length <= 200episode_id*Episode Id
Episode whose replay is being coached.
Format
uuidcoworld_id?|
Coworld version that ran the episode.
replay_uri*Replay Uri
Replay artifact the viewer loaded.
Length
1 <= length <= 2048policy_version_id?|
Coached PolicyVersion; must be seated in the episode and owned by the caller.
slot?|
Seat the coached policy occupied; must match the episode's roster.
declared_context?Declared Context
Starting context the author wrote before recording, such as what they intend to coach.
Length
length <= 20000Default
""curl -X POST "https://softmax.com/api/observatory/v2/coaching-sessions" \ -H "Content-Type: application/json" \ -d '{ "idempotency_key": "string", "episode_id": "a7b62598-1927-4181-99d5-5d746c0bbcfe", "replay_uri": "string" }'{ "id": "string", "upload": { "url": "string", "key": "string", "content_type": "string", "expires_at": "2019-08-24T14:15:22Z" }}