Developer API

Authorization: Bearer YOUR_API_KEY

// List your videos
const response = await fetch('https://api.streamvault.one/v1/videos', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data.videos);

{
  "pager": {
    "page": 1,
    "totalPages": 1,
    "totalResults": 10,
    "sort": ""
  },
  "videos": [
    {
      "id": "fFL56RU6PjvJPeE",
      "title": "My Video",
      "channelKey": "f8RMr2q4h6yNpv9",
      "status": 3,
      "created": "2024-01-15T10:30:00Z"
    }
  ]
}

{
  "error": "Rate limit exceeded. Please slow down and try again shortly."
}

{
  "error": "Invalid or revoked API key"
}

// Upload a video via URL
const response = await fetch('https://api.streamvault.one/v1/videos', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channelKey: 'abc123',
    url: 'https://example.com/video.mp4'
  })
});

const video = await response.json();
console.log(video.iframeLink);

curl -X POST https://api.streamvault.one/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Kinana VOD AR",
    "description": "Arabic news bulletins for the Kinana brand",
    "parent_id": null
  }'

{
  "id": "448ba8b6-eaa6-4ff8-80be-9a075e47c642",
  "user_id": "...",
  "name": "Kinana VOD AR",
  "description": "...",
  "parent_id": null,
  "created_at": "2026-05-07T...",
  "updated_at": "2026-05-07T..."
}

{ "name": "Renamed", "description": "New description", "parent_id": "uuid-of-new-parent-or-null" }

{
  "id": "uuid",
  "name": "Daily News Cleanup",
  "project_ids": ["uuid1", "uuid2"],
  "retention_days": 15,
  "title_filter": { "enabled": false, "value": "" },
  "is_active": true,
  "last_run_at": "2026-05-09T12:00:00Z",
  "last_run_deleted_count": 7,
  "created_at": "2026-05-01T00:00:00Z",
  "updated_at": "2026-05-09T12:00:00Z"
}

curl -X POST https://api.streamvault.one/v1/auto-delete-plans \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily News 15-day cleanup",
    "project_ids": ["uuid-of-project-1"],
    "retention_days": 15,
    "title_filter": { "enabled": true, "value": "daily news" },
    "is_active": true
  }'

curl -X POST https://api.streamvault.one/v1/auto-delete-plans/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "page": 1, "pageSize": 50 }'

{
  "plans": [ /* ... */ ],
  "pager": { "page": 1, "pageSize": 50, "totalResults": 3, "totalPages": 1 }
}

curl -X PUT https://api.streamvault.one/v1/projects/PROJECT_ID/logo \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@./logo.png" \
  -F "auto_apply=true" \
  -F 'palette={"vibrant":"#FFC800","dark_muted":"#121218","muted":"#FFFFFF","text_on_vibrant":"#000000"}'

curl -X PUT https://api.streamvault.one/v1/projects/PROJECT_ID/logo \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "url=https://example.com/logo.png" \
  -F "auto_apply=true"

{
  "logo_url": "https://api.streamvault.one/b2/project-logos/PROJECT_ID/logo.png",
  "logo_palette": {
    "vibrant": "#FF6B35",
    "dark_vibrant": "#7A2E0E",
    "light_vibrant": "#FFB89A",
    "muted": "#806257",
    "dark_muted": "#3B2A20",
    "light_muted": "#D4C4BA",
    "text_on_vibrant": "#FFFFFF",
    "extracted_at": "2026-05-09T22:00:00Z"
  },
  "applied": true,
  "applied_fields": [
    "controls_color", "big_play_color", "big_play_icon_color",
    "player_color", "watermark_color"
  ]
}

curl -X POST https://api.streamvault.one/v1/projects/PROJECT_ID/logo/apply \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -X DELETE https://api.streamvault.one/v1/projects/PROJECT_ID/logo \
  -H "Authorization: Bearer YOUR_API_KEY"

Per-video override     (highest priority, video.player_settings JSONB)
   ↓
Channel default        (channel_player_settings)
   ↓
Project default        (project_player_settings — also where logo palette writes)
   ↓
Account default        (account_player_settings — set in Global Settings → Player Skins)

{
  "skin": "modern",
  "player_color": "#0E1014",
  "controls_color": "#4CC2E0",
  "watermark_color": "#FFFFFF",
  "controls_opacity": 90,
  "watermark_opacity": 70,

  "big_play_button": true,
  "big_play_color": null,
  "big_play_icon_color": null,
  "big_play_opacity": 100,
  "big_play_size": "md",
  "big_play_shape": "circle",
  "big_play_show_on_hover": false,

  "autoplay": false,
  "start_muted": false,
  "loop": false,
  "captions_on_by_default": false,
  "seek_buttons": true,
  "fullscreen_control": true,

  "ip_watermark": false,

  "playback_speed_control": true,
  "allow_fast_forward": true,
  "click_for_sound": false,
  "click_to_resume": false,
  "auto_resume_playback": false,
  "default_quality": "auto",
  "default_volume": 100,

  "show_player_controls": true,
  "persistent_control_bar": false,
  "volume_control": true,
  "quality_selector": true,
  "sticky_player": false,
  "pause_on_scroll": false
}

curl -X PATCH https://api.streamvault.one/v1/projects/PROJECT_ID/player-settings \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "skin": "pill",
    "controls_color": "#FF6B35",
    "big_play_size": "lg",
    "big_play_show_on_hover": true,
    "ip_watermark": true
  }'

{
  "title": "Subscribe",
  "url": "https://example.com",
  "type": "link",            // "link" or "email"
  "show_at": 0,               // seconds; when to appear
  "hide_at": null,            // seconds; null = until end
  "position": "bottom-right", // top/bottom x left/center/right
  "background": "#2764EB",    // null = brand palette fallback
  "text_color": "#ffffff"
}

{
  "event": "videoPublished",
  "video": {
    "Id": "YOUR_VIDEO_ID",
    "Duration": "00:00:02.2200000",
    "ProjectId": "YOUR_PROJECT_ID",
    "AccountKey": "YOUR_ACCOUNT_KEY",
    "Region": "use",
    "Image": {
      "xsUrl": "",
      "smUrl": "",
      "mdUrl": "",
      "lgUrl": ""
    },
    "Captions": [],
    "Key": "YOUR_VIDEO_KEY",
    "ChannelKey": "YOUR_CHANNEL_KEY",
    "PrivateLink": "YOUR_PRIVATE_LINK",
    "IframeLink": "YOUR_IFRAME_LINK",
    "HLSLink": "YOUR_HLS_LINK",
    "PlanType": 1,
    "Mp4Url": "",
    "Mp4Urls": [],
    "Formats": {
      "Hls": true,
      "Mp4": false,
      "Options": { "SecureMp4": true }
    },
    "HLSUrl": "YOUR_HLS_URL",
    "HLSUrlWeb": "YOUR_HLS_URL_WEB",
    "Title": "YOUR_VIDEO_TITLE",
    "Description": "YOUR_VIDEO_DESCRIPTION",
    "Options": {},
    "Tags": [],
    "Version": 1,
    "Status": 3,
    "Created": "2024-01-15T10:30:00Z"
  }
}

import StreamVault from '@streamvault/sdk';

const sv = new StreamVault({ apiKey: 'YOUR_API_KEY' });

// List videos
const { videos } = await sv.videos.list();

// Upload via URL
const video = await sv.videos.upload({
  url: 'https://example.com/video.mp4',
  title: 'My Video'
});

console.log(video.iframeLink);

import { StreamVaultPlayer } from '@streamvault/react';

function App() {
  return (
    <StreamVaultPlayer
      videoId="YOUR_VIDEO_ID"
      autoplay={false}
      controls
      style={{ width: '100%', maxWidth: 800 }}
    />
  );
}

<!-- Embed StreamVault Player -->
<iframe 
  src="https://player.streamvault.one/embed/VIDEO_ID"
  width="640" 
  height="360" 
  frameborder="0" 
  allow="encrypted-media"
  allowfullscreen>
</iframe>