Skip to content
Qualia Docs

Bounded trajectory samples for one exact DatasetVersion member

POST
/v1/datasets/episode-trajectory
 
curl --request POST \
  --url https://example.com/v1/datasets/episode-trajectory \
  --header 'Content-Type: application/json' \
  --data '{ "dataset_version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "member_ordinal": 1, "episode_revision_id": "example", "frame_offset": 0, "frame_count": 1, "streams": [ "action" ], "max_points": 400 }'

Read only the exact membership token supplied by the caller.

There is intentionally no dataset-name/index compatibility path: clients obtain this token from ExploreLake or ResolveDatasetVersion and must carry it unchanged into the read.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

Header Parameters

Section titled “Header Parameters ”
x-api-key
string | null

Request Body required

Section titled “Request Body required ”
Media type application/json
EpisodeTrajectoryBody
object
dataset_version_id
required
string format: uuid
member_ordinal
required
integer
<= 9223372036854776000
episode_revision_id
required
string
/^[0-9a-f]{64}$/
frame_offset
integer
0 <= 18446744073709552000
frame_count
integer | null
>= 1 <= 18446744073709552000
streams
Array<string>
<= 2 items
Allowed values: action state
max_points
integer
default: 400 >= 2 <= 2000

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
EpisodeTrajectoryResponseModel
object
dataset_version_id
required
string format: uuid
member_ordinal
required
integer
<= 9223372036854776000
episode_revision_id
required
string
/^[0-9a-f]{64}$/
artifacts
required
Array<object>
>= 1 items <= 1024 items
EpisodeTrajectoryArtifactModel
object
source_file_id
required
string format: uuid
path
required
string
>= 1 characters <= 4096 characters
manifest_id
required
string
/^[0-9a-f]{64}$/
logical_size
required
integer
> 0 <= 18446744073709552000
artifact_frame_start
required
integer
<= 18446744073709552000
artifact_frame_end
required
integer
> 0 <= 18446744073709552000
selection_frame_start
required
integer
<= 18446744073709552000
selection_frame_end
required
integer
> 0 <= 18446744073709552000
frame_offsets
required
Array<integer>
>= 1 items <= 2000 items
t
required
Array<number>
>= 1 items <= 2000 items
action
required
object
<= 4096 properties
key
additional properties
Array<number>
state
required
object
<= 4096 properties
key
additional properties
Array<number>
validity
required
object
key
additional properties
object
key
additional properties
Array<boolean>
frames
required
integer
> 0 <= 18446744073709552000
fps
required
number
> 0
downsampled
required
boolean
Example generated
{
  "dataset_version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "member_ordinal": 1,
  "episode_revision_id": "example",
  "artifacts": [
    {
      "source_file_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "path": "example",
      "manifest_id": "example",
      "logical_size": 1,
      "artifact_frame_start": 1,
      "artifact_frame_end": 1,
      "selection_frame_start": 1,
      "selection_frame_end": 1
    }
  ],
  "frame_offsets": [
    1
  ],
  "t": [
    1
  ],
  "action": {
    "additionalProperty": [
      1
    ]
  },
  "state": {
    "additionalProperty": [
      1
    ]
  },
  "validity": {
    "additionalProperty": {
      "additionalProperty": [
        true
      ]
    }
  },
  "frames": 1,
  "fps": 1,
  "downsampled": true
}

401

Section titled “401 ”

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

404

Section titled “404 ”

Unknown, mismatched, or foreign immutable member

412

Section titled “412 ”

Exact artifact is not interactively readable

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}