Skip to content
Qualia Docs

Immutable detail and video assets for one exact DatasetVersion member

POST
/v1/datasets/version-episode
 
curl --request POST \
  --url https://example.com/v1/datasets/version-episode \
  --header 'Content-Type: application/json' \
  --data '{ "dataset_version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "member_ordinal": 1, "episode_revision_id": "example" }'

Resolve no mutable state: the complete membership token is mandatory.

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
VersionEpisodeBody
object
dataset_version_id
required
string format: uuid
member_ordinal
required
integer
<= 9223372036854776000
episode_revision_id
required
string
/^[0-9a-f]{64}$/
Example generated
{
  "dataset_version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "member_ordinal": 1,
  "episode_revision_id": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
VersionEpisodeResponseModel
object
dataset_version_id
required
string format: uuid
member_ordinal
required
integer
<= 9223372036854776000
episode_revision_id
required
string
/^[0-9a-f]{64}$/
episode_id
required
string format: uuid
dataset_id
required
string format: uuid
episode_index
required
integer
<= 4294967295
frame_count
required
integer
> 0 <= 18446744073709552000
duration_seconds
required
number
> 0
fps
required
number
> 0
task
string | null
<= 512 characters
tags
Array<string>
<= 512 items
tier
string
nullable
Allowed values: retrainable analyze_only
review_state
string
nullable
Allowed values: unreviewed auto_accepted human_audited rejected
source_revision
required
integer
<= 2147483647
base_frame_start
required
integer
<= 18446744073709552000
base_frame_end
required
integer
> 0 <= 18446744073709552000
base_duration_us
required
integer
> 0 <= 18446744073709552000
frame_start
required
integer
<= 18446744073709552000
frame_end
required
integer
> 0 <= 18446744073709552000
time_start_us
required
integer
<= 18446744073709552000
time_end_us
required
integer
> 0 <= 18446744073709552000
subtasks
Array<object>
<= 4096 items
VersionEpisodeSubtaskModel
object
start_us
required
integer
<= 18446744073709552000
end_us
required
integer
> 0 <= 18446744073709552000
subtask
required
string
>= 1 characters <= 16384 characters
artifact_count
required
integer
> 0 <= 1024
urls
Array<object>
<= 512 items
VersionEpisodeAssetModel
object
camera
required
string
>= 1 characters <= 1024 characters
url
required
string
>= 1 characters <= 16384 characters
expires_at_unix
required
integer
> 0
from_s
required
number
to_s
required
number
Example 
{
  "tier": "retrainable",
  "review_state": "unreviewed"
}

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 ”

Immutable detail is not available for this scope

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": {}
    }
  ]
}