Skip to main content
POST
Register a file in the media library

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Body

application/json
url
string
required

Absolute http(s) URL of the file

name
string

Display name. Derived from the URL when omitted - this is what search matches on, so a descriptive name is worth sending.

altText
string | null

Alternative text, used by screen readers and searched alongside the name

caption
string | null
mediaType
enum<string>

Inferred from the URL extension when omitted

Available options:
image,
video

Response

The registered media item

An item in the organization's media library. Files are hosted externally (Cloudinary for anything uploaded through the admin editor); this record is the library entry that website sections and content reference by url.

id
integer
url
string

Public URL of the file. Immutable - register a new item to replace a file.

name
string

Display name. Searched, along with altText, when looking an image up by name.

altText
string | null

Alternative text for screen readers. Also searched.

caption
string | null
mediaType
enum<string>
Available options:
image,
video
createdAt
string<date-time>
updatedAt
string<date-time>
created
boolean

False when the URL was already in the library