Media
Manage media items (collections of files)
Media Objects
A media object is a collection of files. It can be used to store images, videos, or other files.
Endpoints
Get all media
Retrieves a list of all media for the current project
Authorization
Authorization
RequiredBearer <token>Requires a Bearer token in the Authorization header. Format: Authorization: Bearer YOUR_API_KEY
In: header
Query Parameters
page
integerPage number for pagination.
1
Minimum: 1
limit
integerNumber of media items to return per page.
12
Minimum: 1
Maximum: 100
Response Body
A list of media items
TypeScript Definitions
Use the response body type in TypeScript.
meta
objectdata
array<object>links
objectCreate a new media item
Creates a new media item from a URL or as an empty placeholder
Authorization
Authorization
RequiredBearer <token>Requires a Bearer token in the Authorization header. Format: Authorization: Bearer YOUR_API_KEY
In: header
Request Body
application/json
RequiredInformation needed to create a new media item, either from a URL or as an empty placeholder.
url
stringURL of the media file to ingest. Required unless 'empty' is true.
"uri"
label
stringLabel for the media
folder
stringFolder to store the media in
filename
stringFilename for the media
title
stringTitle for the media
metadata
objectAdditional metadata for the media
async
booleanWhether to process the media asynchronously
false
empty
booleanCreate an empty media placeholder
false
Response Body
Media created successfully
TypeScript Definitions
Use the response body type in TypeScript.
meta
objectdata
objectlinks
objectGet media by ID
Retrieves a specific media item by its ID
Authorization
Authorization
RequiredBearer <token>Requires a Bearer token in the Authorization header. Format: Authorization: Bearer YOUR_API_KEY
In: header
Path Parameters
id
RequiredstringThe media ID
Response Body
Media item details
TypeScript Definitions
Use the response body type in TypeScript.
meta
objectdata
objectlinks
objectDemonstrates a successful response when retrieving a video media item with associated source files and metadata
Delete media by ID
Deletes a specific media item by its ID
Authorization
Authorization
RequiredBearer <token>Requires a Bearer token in the Authorization header. Format: Authorization: Bearer YOUR_API_KEY
In: header
Path Parameters
id
RequiredstringThe media ID
Response Body
Media deleted successfully
TypeScript Definitions
Use the response body type in TypeScript.
meta
objectdata
objectlinks
object