Skip to main content
GET
Get episode request

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

episode_request_id
string
required

Episode request to return.

Pattern: ^ereq_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

id
string
required

Episode request ID.

requester_user_id
string
required

User who created the episode request.

status
enum<string>
required

Current execution state.

Available options:
pending,
submitted,
running,
completed,
failed,
cancelled
policy_version_ids
string<uuid>[]
required

Policy versions assigned to policy-controlled seats.

participants
(V2EpisodeRequestPolicyParticipant · object | V2EpisodeRequestHumanParticipant · object)[]
required

Episode participants in seat order.

scores
EpisodeRequestScore · object[]
required

Scores recorded for the episode.

created_at
string<date-time>
required

Time when the episode request was created.

round_id
string | null

Round that created the request, or null for non-round episodes.

coworld_id
string | null

Coworld used by the episode.

coworld_name
string | null

Name of the Coworld used by the episode.

coworld_version
string | null

Coworld version used by the episode.

variant_name
string | null

Coworld variant used by the episode, or null when none was selected.

max_steps
integer | null

Maximum environment steps, or null when the Coworld default applies.

job_index
integer | null

Position within the parent request or round, or null when there is no parent.

job_id
string<uuid> | null

Execution job ID, or null until the request is dispatched.

episode_id
string<uuid> | null

Recorded episode ID, or null until an episode exists.

replay_url
string | null

URL for watching the completed episode.

live_url
string | null

URL for watching the running episode.

error_type
string | null

Failure category, or null when no failure was recorded.

error
string | null

Failure message, or null when no failure was recorded.

failed_policy_index
integer | null

Policy seat that failed, or null when the failure is not policy-specific.

failed_agent_index
integer | null

Agent index that failed, or null when the failure is not agent-specific.

participant_scores
CoworldEpisodeParticipantScore · object[]

Scores attributed to individual participants.

dispatched_at
string<date-time> | null

Time when execution was dispatched, or null until dispatch.

running_at
string<date-time> | null

Time when execution started, or null until it starts.

completed_at
string<date-time> | null

Time when execution finished, or null until it finishes.

cost_usd
number | null

Measured execution cost in US dollars, or null until available.

game_config
Game Config · object | null

Public game configuration used for the episode.