EndpointsCoaching Sessions
Finish coaching session
POST
/v2/coaching-sessions/{coaching_session_id}/finishMarks the recording complete once its video has been uploaded and pins its duration and hash.
Authorization
BearerAuth AuthorizationBearer <token>
Bearer token issued by Softmax
In: header
Path Parameters
coaching_session_id*Coaching Session Id
Coaching session to finish.
Match
^csn_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Request Body
application/json
duration_ms*Duration Ms
Recording length excluding paused time.
Range
0 < valuevideo?|
Omit when the browser could not capture video.
tick_alignment*CoachingTickAlignment
Whether the viewer reported game ticks while recording.
Value in
- "available"
- "unavailable"
curl -X POST "https://softmax.com/api/observatory/v2/coaching-sessions/string/finish" \ -H "Content-Type: application/json" \ -d '{ "duration_ms": 1, "tick_alignment": "available" }'{ "id": "string", "episode_id": "a7b62598-1927-4181-99d5-5d746c0bbcfe", "coworld_id": "string", "coworld_name": "string", "episode_thumbnail_url": "string", "recording_url": "string", "user_id": "string", "status": "recording", "tick_alignment": "available", "duration_ms": 0, "policy_reference": { "status": "seated", "policy_version_id": "7cd41427-f4be-4006-ab17-5ead7f8f8446", "slot": 0 }, "has_video": true, "latest_analysis": { "id": "string", "provider": "string", "model": "string", "prompt_version": "string", "status": "queued", "phase": "string", "upload_percent": 0, "usage_usd": 0, "error": "string", "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z" }, "feed": { "summary": "string", "quote": "string", "insights": [ "string" ] }, "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "replay_uri": "string", "declared_context": "string", "video_bytes": 0, "video_sha256": "string", "timeline": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "note", "at_ms": 0, "end_ms": 0, "tick": 0, "text": "string", "original_text": "string", "correction_id": "83f8a476-6142-46ed-8c65-3d77391f7d26", "payload": {} } ], "moments": [ { "id": "string", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "start_ms": 0, "end_ms": 0, "tick_start": 0, "tick_end": 0, "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a", "evidence_ids": [ "973ab5a6-b373-447d-ab9d-bdb660b35afc" ], "association": "Nearby in recording time; intent and accepted game actions are unverified." } ], "revisions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "text": "string", "start_ms": 0, "end_ms": 0, "author_user_id": "string" } ], "analyses": [ { "id": "string", "provider": "string", "model": "string", "prompt_version": "string", "status": "queued", "phase": "string", "upload_percent": 0, "usage_usd": 0, "error": "string", "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z" } ], "limitations": [ "string" ]}