List children of a Directory media asset

GET

/media/{mediaId}/children

Returns a paginated list of File children (e.g. per-token metadata or extracted archive files).

Authorizations

bearerAuth

Parameters

Path Parameters

mediaId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

cursor

string

limit

integer

> 0 <= 500

Responses

200

Children page

object

items

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

accountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: File Directory

scope

required

string

Allowed values: Collection User

provenance

required

string

Allowed values: UserUpload SystemGenerated

status

required

string

Allowed values: Pending Processing Ready Failed

fileName

required

string

mimeType

required

Any of:

string
null

string

fileSize

required

Any of:

integer
null

integer

<= 9007199254740991

contentHash

required

Any of:

string
null

string

parentId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

path

required

Any of:

string
null

string

uploadedAt

required

Any of:

string
null

string

locations

required

Array<object>

object

required

string

mediaId

required

string

provider

required

string

Allowed values: R2 Arweave S3 IPFS

role

required

string

Allowed values: Origin Archive Mirror

reference

required

string

status

required

string

Allowed values: Pending Succeeded Failed

attempts

required

integer

<= 9007199254740991

lastError

required

Any of:

string
null

string

syncedAt

required

Any of:

string
null

string

metadata

required

Any of:

object
null

object

key

additional properties

createdAt

required

string

updatedAt

required

string

url

required

Any of:

string
null

string format: uri

createdAt

required

string

updatedAt

required

string

nextCursor

required

Any of:

string
null

string

400

Not a Directory

401

Unauthorized

403

Forbidden

404

Not found