Skip to main content
GET
Get experience request

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

experience_request_id
string
required

Experience Request to return.

Pattern: ^xreq_[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

Experience request ID.

requester_user_id
string
required

User who created the experience request.

coworld_id
string
required

Coworld used by the requested episodes.

coworld_name
string
required

Name of the Coworld used by the requested episodes.

coworld_version
string
required

Coworld version used by the requested episodes.

variant_id
string | null
required

Coworld variant, or null when no variant was selected.

status
enum<string>
required

Current state of the experience request.

Available options:
pending,
submitted,
running,
completed,
failed,
cancelled
episode_count
integer
required

Total episodes created for the request.

pending_count
integer
required

Episodes waiting to be submitted for execution.

submitted_count
integer
required

Episodes submitted for execution but not yet running.

running_count
integer
required

Episodes currently running.

completed_count
integer
required

Episodes that completed successfully.

failed_count
integer
required

Episodes that failed.

error
string | null
required

Request-level failure message, or null when none was recorded.

created_at
string<date-time>
required

Time when the experience request was created.

started_at
string<date-time> | null
required

Time when execution began, or null until it starts.

completed_at
string<date-time> | null
required

Time when execution finished, or null until it finishes.

episodes
V2EpisodeRequestRow · object[]
required

Episode requests created by this experience request.

requester
string | null

Display name of the requester.

can_cancel
boolean
default:false

Whether the caller can cancel this experience request.

requested
Requested · object | null

Original purpose and roster request.

cost_preview
V2ExperienceRequestCostPreview · object | null

Admission-time cost estimate, present only in the create response.