Register a file in the media library
Adds an already-hosted file to the library so website sections and content can reference it. The API does not accept file uploads - upload to your image host first (the admin editor uses Cloudinary) and register the resulting URL here.
Idempotent per URL: registering one the organization already has updates whatever metadata you send and returns the existing item, with created: false.
Authorizations
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Body
Absolute http(s) URL of the file
Display name. Derived from the URL when omitted - this is what search matches on, so a descriptive name is worth sending.
Alternative text, used by screen readers and searched alongside the name
Inferred from the URL extension when omitted
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.
Public URL of the file. Immutable - register a new item to replace a file.
Display name. Searched, along with altText, when looking an image up by name.
Alternative text for screen readers. Also searched.
image, video False when the URL was already in the library