API Referencemedia

Create

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
namestringOptional<=256 charactersDefaults to
Name of the media item
source_urlstring or nullOptionalformat: "uri"1-2083 characters
Original source URL of the media
knowledge_graphstring or nullOptionalformat: "uuid"
ID of the knowledge graph to associate with.
descriptionstring or nullOptional
Description of the media
channelstring or nullOptionalformat: "uuid"
ID of the channel to associate with.
messagestring or nullOptionalformat: "uuid"
ID of the message to associate with.

Response

Successful Response
idstringformat: "uuid"
createdstringformat: "date-time"
modifiedstringformat: "date-time"
namestring or null<=256 characters
urlstring or nullformat: "uri"1-2083 characters

Preview/processed URL (e.g., JPG preview for PDFs)

source_urlstring or nullformat: "uri"1-2083 characters

Original file URL (e.g., the original PDF before processing)

descriptionstring or null
statusstring or null

Human-readable status label

formatstring or null<=10 charactersDefaults to
resource_typestring or null<=10 charactersDefaults to
widthinteger or nullDefaults to 0
heightinteger or nullDefaults to 0

Errors