Skip to content
Qualia Docs

Versions_ListMaterializationArtifacts

GET
/v1/accounts/{account}/datasets/{dataset}/versions/{version}/materializations/{materialization}/artifacts
 
curl --request GET \
  --url https://junction-api.qualiastudios.dev/v1/accounts/example/datasets/example/versions/example/materializations/example/artifacts \
  --header 'X-API-Key: <X-API-Key>'

A rendered dataset’s files in path order, each with a fresh signed URI. FAILED_PRECONDITION until the materialization has SUCCEEDED.

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.

version
required
string

The version id.

materialization
required
string

The materialization id.

Query Parameters

Section titled “Query Parameters ”
pageSize
integer format: int32

At most this many; 0 means 128, the maximum is 512.

pageToken
string

From a previous response’s next_page_token. A token from before a new renderer took over is refused (FAILED_PRECONDITION): list again from the start.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Versions.ListMaterializationArtifacts.

object
materializationArtifacts

One page of files, in path order.

Array<object>

One file of a rendered dataset.

object
name

…/materializations/{materialization}/artifacts/{artifact}; {artifact} is its position in the listing, from 0.

string
path

Where it goes in the dataset’s directory, e.g. “meta/info.json”.

string
role

What it holds.

string format: enum
Allowed values: ROLE_UNSPECIFIED META DATA VIDEO
sizeBytes

Its size in bytes.

string
sha256

Lowercase hex SHA-256 of its bytes, to check a download against.

string
episode

Accounts/{account}/datasets/{dataset}/episodes/{episode}: the episode it was rendered from, when it holds one episode only.

string
camera

The camera key, for a video.

string
uri

Signed GET URI of its bytes; honours HTTP Range. Valid until expire_time.

string
expireTime

When uri stops working; list again for a fresh one.

string format: date-time
nextPageToken

Empty on the last page.

string
Example 
{
  "materializationArtifacts": [
    {
      "role": "ROLE_UNSPECIFIED"
    }
  ]
}

default

Section titled “default ”

Default error response

Media type application/json
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

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.

Array<object>
object
Example generated
{
  "code": "example",
  "message": "example",
  "retryable": true,
  "details": [
    {}
  ]
}