Episodes_SampleEpisodeSeries
const url = 'https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes/example:sampleSeries';const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example/episodes/example:sampleSeries \ --header 'X-API-Key: <X-API-Key>'The episode’s joint series: each state and action channel sampled evenly over the take’s current content: the joints drawer’s charts, and the arm’s motion the camera lag drawer sets each camera’s offset against. Its window says where those samples sit in the episode’s recording. A handheld take resolved at its TCP also has the hands’ TCP poses, when streams names TCP. A take in no published version yet answers unpublished, with no channels; FAILED_PRECONDITION means the published content cannot be sampled (a column type it cannot read, say).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The account id.
The dataset id.
The episode id.
Query Parameters
Section titled “Query Parameters ”Samples to return at most, 2 to 2000; 400 when unset. A take with fewer frames returns every frame. The first and last frame are always samples.
The vectors to sample, each at most once; STATE and ACTION when empty (TCP only when named). A take whose action cannot be read still answers for its state alone, and one with no TCP (not a handheld take resolved at its TCP) answers for the rest without it.
Read as this version froze it: a tag, stable, v0 or a
digest prefix; empty or head reads the episode as it is now. As
GetEpisodeRequest.version: the series of the member that version holds.
Responses
Section titled “ Responses ”OK
Response for Episodes.SampleEpisodeSeries.
object
Seconds from the first frame sampled, one per sample: a sample’s second of the episode’s recording is this plus window_start_seconds.
Every channel the recording carries, on time_seconds.
One channel: one component of the state or the action vector.
object
Which vector.
Its positional key, “state[3]” or “action[3]”; the dataset’s robot interface names the positions. A TCP channel is named, “left.tcp.x”.
One value per sample; 0 where valid is false.
Per sample: false where the recording holds no finite value.
The recording’s frames per second.
Frames sampled: the take’s, or what its applied trim keeps.
True when the take is in no published version yet (a split child before its publish): it has no channels to sample.
Where the first frame sampled sits in the episode’s recording, in seconds of the recording (the clock its trim, subtasks and markers are in), on that frame: 0 until a trim is applied, the trim’s start once one is; a split’s piece is a recording of its own, so 0. Unset with unpublished.
Where the frames sampled end in the recording, in the same seconds: the end of the last one (window_start_seconds plus frame_count / fps). Unset with unpublished.
Example
{ "channels": [ { "stream": "STREAM_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
A refusal from the API itself.
object
The gRPC code name in upper case, e.g. NOT_FOUND.
Whether the same call may succeed if retried.
Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.
object
A refusal from the gateway before the call reaches the API, for example 401 bad or missing API key, 403 key lacks the scope or environment closed, 413 body too large.
object
What went wrong.
Example generated
{ "code": "example", "message": "example", "retryable": true, "details": [ {} ]}