API Reference
Shareable Links
Create share links via the Client API
Create Shareable Link
POST /shareable-linksCreate a share link for a video, live stream, or collection. Public or password-protected.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
media_id | string | Yes | ID of the video, stream, or collection |
media_type | string | Yes | vod, live, or collection |
visibility | string | Yes | public or password |
password | string | If password | Min 6 characters |
expires_in_days | integer | No | Expiry in days (1-365) |
Example request
curl -X POST "https://your-domain.com/api/client/v1/shareable-links" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"media_id": "019f2581-e0cf-719e-a060-95ef7567c7c7",
"media_type": "vod",
"visibility": "password",
"password": "secret123",
"expires_in_days": 30
}'Response (201)
{
"link": "https://your-domain.com/share/abc123token",
"token": "abc123token",
"visibility": "password",
"expires_at": "2026-08-02T12:00:00+00:00"
}Errors
| Status | Description |
|---|---|
| 404 | Media resource not found or not in your tenant |
| 422 | Validation error (invalid media_type, missing password, etc.) |
Media types
| Type | media_type | Description |
|---|---|---|
| Video | vod | Single video share |
| Live stream | live | Live stream share page |
| Collection | collection | Entire folder/collection |
See Sharing & Embeds for how viewers access links and verify passwords.