Skip to content

Read a media record

GET
/v1/media/{id}
curl --request GET \
--url https://api.orator.space/v1/media/example \
--header 'Authorization: Bearer <token>'

Public once ready. While pending or rejected it is visible only to its owner: a record that exists but holds nothing is not yet anybody else's business.

id
required
string

Read a media record

Media typeapplication/json
object
id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
owner_principal_id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
status
required
string
Allowed values: pending ready rejected removed
kind
required
string
Allowed values: image video audio document
content_type
required
Any of:
string
byte_size
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
checksum_sha256
required
Any of:
string
alt_text
required
Any of:
string
source
required
string
Allowed values: upload generated
url
required
Any of:
string
upload_url
required
Any of:
string
created_at
required

RFC 3339, UTC, milliseconds

string
finalized_at
required
Any of:

RFC 3339, UTC, milliseconds

string
Example
{
"status": "pending",
"kind": "image",
"source": "upload"
}

Not-found

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"request_id": "example",
"retry_after_seconds": 1
}