Skip to content
Qualia Docs

Episodes_SampleEpisodeSeries

GET
/v1/accounts/{account}/datasets/{dataset}/episodes/{episode}:sampleSeries
 
curl --request GET \
  --url https://dev-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 ”
account
required
string

The account id.

dataset
required
string

The dataset id.

episode
required
string

The episode id.

Query Parameters

Section titled “Query Parameters ”
maxPoints
integer format: int32

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.

streams
Array<string>
Allowed values: STREAM_UNSPECIFIED STATE ACTION TCP

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.

version
string

Read as this version froze it (QUA-3539): 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 ”

200

Section titled “200 ”

OK

Media type application/json

Response for Episodes.SampleEpisodeSeries.

object
timeSeconds

Seconds from the first frame sampled, one per sample: a sample’s second of the episode’s recording is this plus window_start_seconds.

Array<number>
channels

Every channel the recording carries, on time_seconds.

Array<object>

One channel: one component of the state or the action vector.

object
stream

Which vector.

string format: enum
Allowed values: STREAM_UNSPECIFIED STATE ACTION TCP
key

Its positional key, “state[3]” or “action[3]”; the dataset’s robot interface names the positions. A TCP channel is named, “left.tcp.x”.

string
values

One value per sample; 0 where valid is false.

Array<number>
valid

Per sample: false where the recording holds no finite value.

Array<boolean>
fps

The recording’s frames per second.

number format: double
frameCount

Frames sampled: the take’s, or what its applied trim keeps.

string
unpublished

True when the take is in no published version yet (a split child before its publish): it has no channels to sample.

boolean
windowStartSeconds

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.

number format: double
windowEndSeconds

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.

number format: double
Example 
{
  "channels": [
    {
      "stream": "STREAM_UNSPECIFIED"
    }
  ]
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}