Canonical API

GET /api/v1/channels

List Channels

listChannels · channels:read

GET /api/v1/channels/{channel}

Get Channel

getChannel · channels:read

GET /api/v1/channels/{channel}/competitors

List Channel Competitors

listChannelCompetitors · channels:read

POST /api/v1/channels/{channel}/competitors

Add Channel Competitor

addChannelCompetitor · scripts:write

DELETE /api/v1/channels/{channel}/competitors/{competitor}

Delete Channel Competitor

deleteChannelCompetitor · scripts:write

GET /api/v1/channels/{channel}/ideas

List Channel Ideas

listChannelIdeas · scripts:read

POST /api/v1/channels/{channel}/ideas

Create Channel Idea

createChannelIdea · scripts:write

POST /api/v1/channels/{channel}/ideas/generate

Generate Channel Ideas

generateChannelIdeas · scripts:write

POST /api/v1/channels/{channel}/ideas/generate-from-channel

Generate Ideas From Channel

generateIdeasFromChannel · scripts:write

POST /api/v1/channels/{channel}/ideas/generate-from-video

Generate Ideas From Video

generateIdeasFromVideo · scripts:write

GET /api/v1/ideas/{idea}

Get Idea

getIdea · scripts:read

POST /api/v1/ideas/{idea}/change-topic

Change Idea Topic

changeIdeaTopic · scripts:write

POST /api/v1/ideas/{idea}/write

Write Idea

writeIdea · scripts:write

GET /api/v1/intel/bookmarks

List Intel Bookmarks

listIntelBookmarks · intel:read

POST /api/v1/intel/bookmarks

Create Intel Bookmark

createIntelBookmark · intel:write

DELETE /api/v1/intel/bookmarks/{bookmark}

Delete Intel Bookmark

deleteIntelBookmark · intel:write

POST /api/v1/intel/channels/lookup

Lookup Intel Channel

lookupIntelChannel · intel:read

POST /api/v1/intel/channels/search

Search Intel Channels

searchIntelChannels · intel:read

POST /api/v1/intel/videos/lookup

Lookup Intel Video

lookupIntelVideo · intel:read

POST /api/v1/intel/videos/search

Search Intel Videos

searchIntelVideos · intel:read

GET /api/v1/operations/{operation}

Get an asynchronous operation

getOperation · operations:read

GET /api/v1/projects

List Projects

listProjects · projects:read

POST /api/v1/projects

Create Project

createProject · projects:write

GET /api/v1/projects/{project}

Get Project

getProject · projects:read

PATCH /api/v1/projects/{project}

Update Project

updateProject · projects:write

POST /api/v1/projects/{project}/move

Move Project

moveProject · projects:write

POST /api/v1/projects/{project}/promote

Promote idea Project

promoteProject · projects:write

POST /api/v1/projects/{project}/archive

Archive Project

archiveProject · projects:write

POST /api/v1/projects/{project}/restore

Restore Project

restoreProject · projects:write

GET /api/v1/projects/{project}/comments

List Project comments

listProjectComments · projects:read

POST /api/v1/projects/{project}/comments

Create Project comment

createProjectComment · projects:write

GET /api/v1/projects/{project}/activity

List Project activity

listProjectActivity · projects:read

GET /api/v1/projects/{project}/attachments

List Project attachment metadata

listProjectAttachments · projects:read

GET /api/v1/tasks

List assigned Project tasks

listProjectTasks · projects:read

GET /api/v1/project-notifications

List Project notifications

listProjectNotifications · notifications:read

POST /api/v1/project-notifications/{notification}/read

Mark one Project notification read

readProjectNotification · notifications:write

POST /api/v1/project-notifications/read-all

Mark all Project notifications read

readAllProjectNotifications · notifications:write

GET /api/v1/projects/{project}/production

Get Project production metadata

getProjectProduction · projects:read

PATCH /api/v1/projects/{project}/production

Update Project production metadata

updateProjectProduction · projects:write

GET /api/v1/channels/{channel}/scripts

List Channel Scripts

listChannelScripts · scripts:read

POST /api/v1/channels/{channel}/scripts

Create Channel Script

createChannelScript · scripts:write

GET /api/v1/scripts/{script}

Get Script

getScript · scripts:read

POST /api/v1/scripts/{script}/agent/generate

Start Script Agent Run

startScriptAgentRun · scripts:write

GET /api/v1/scripts/{script}/agent/runs/{run}

Get Script Agent Run

getScriptAgentRun · scripts:read

POST /api/v1/scripts/{script}/agent/runs/{run}/cancel

Cancel Script Agent Run

cancelScriptAgentRun · scripts:write

GET /api/v1/scripts/{script}/content

Get Script Content

getScriptContent · scripts:read

GET /api/v1/scripts/{script}/export

Export Script

exportScript · scripts:read

GET /api/v1/scripts/{script}/generate/poll

Poll Script Generation

pollScriptGeneration · scripts:read

POST /api/v1/scripts/{script}/outline/generate

Generate Script Outline

generateScriptOutline · scripts:write

POST /api/v1/scripts/{script}/script/generate

Generate Script

generateScript · scripts:write

POST /api/v1/scripts/{script}/script/humanize

Humanize Script

humanizeScript · scripts:write

GET /api/v1/team

Get Team

getTeam

GET /api/v1/team/credits

Get Team Credits

getTeamCredits

GET /api/v1/team/tokens

List Api Tokens

listApiTokens · tokens:manage

POST /api/v1/team/tokens

Create Api Token

createApiToken · tokens:manage

DELETE /api/v1/team/tokens/{token}

Delete Api Token

deleteApiToken · tokens:manage

GET /api/v1/channels/{channel}/templates

List built-in and custom Channel templates

listChannelTemplates · templates:read

POST /api/v1/channels/{channel}/templates

Create a custom Channel template

createTemplate · templates:write

GET /api/v1/channels/{channel}/templates/{template}

Get a custom Channel template

getTemplate · templates:read

PATCH /api/v1/channels/{channel}/templates/{template}

Update a custom Channel template

updateTemplate · templates:write

POST /api/v1/channels/{channel}/templates/{template}/archive

Archive a custom Channel template

archiveTemplate · templates:write

POST /api/v1/channels/{channel}/templates/{template}/restore

Restore an archived custom Channel template

restoreTemplate · templates:write

GET /api/v1/channels/{channel}/thumbnails/generations

List Thumbnail Generations

listThumbnailGenerations · scripts:read, thumbnails:read

POST /api/v1/channels/{channel}/thumbnails/generations

Create Thumbnail Generation

createThumbnailGeneration · scripts:write, thumbnails:write

GET /api/v1/channels/{channel}/thumbnails/generations/{runId}

Get Thumbnail Generation

getThumbnailGeneration · scripts:read, thumbnails:read

GET /api/v1/channels/{channel}/thumbnails/board

Get Thumbnail Board

getThumbnailBoard · thumbnails:read

POST /api/v1/channels/{channel}/thumbnails/board/images

Add Thumbnail Board Images

addThumbnailBoardImages · thumbnails:write

POST /api/v1/channels/{channel}/thumbnails/board/generations

Create Thumbnail Board Generation

createThumbnailBoardGeneration · thumbnails:write

POST /api/v1/channels/{channel}/thumbnails/board/edits

Edit Thumbnail Board Image

editThumbnailBoardImage · thumbnails:write

POST /api/v1/channels/{channel}/thumbnails/board/text

Set Thumbnail Board Text

setThumbnailBoardText · thumbnails:write

POST /api/v1/channels/{channel}/thumbnails/board/export

Export Thumbnail Board Image

exportThumbnailBoardImage · thumbnails:write

POST /api/v1/channels/{channel}/thumbnails/board/assign-to-script

Assign Thumbnail Board Image To Script

assignThumbnailBoardImageToScript · thumbnails:write

GET /api/v1/team/thumbnails/usage

Get Thumbnail Usage

getThumbnailUsage · scripts:read, thumbnails:read

GET /api/v1/video/capabilities

List available Subscribr Video capabilities

videoListCapabilities · video:read

GET /api/v1/video/channels

List Subscribr Video channels for the current team

videoListChannels · video:read

GET /api/v1/video/channels/{videoChannel}

Get a Subscribr Video channel for the current team

videoGetChannel · video:read

GET /api/v1/video/voices

List custom voices available to the current team

videoListVoices · video:read

GET /api/v1/video/voices/{voice}

Get a custom voice available to the current team

videoGetVoice · video:read

GET /api/v1/video/avatars

List custom avatars available to the current team

videoListAvatars · video:read

GET /api/v1/video/avatars/{avatar}

Get a custom avatar available to the current team

videoGetAvatar · video:read

GET /api/v1/video/media-assets

List reference media available to the current team

videoListMediaAssets · video:read

GET /api/v1/video/media-assets/{mediaAsset}

Get reference media available to the current team

videoGetMediaAsset · video:read

GET /api/v1/video/projects

List Subscribr Video projects

videoListProjects · video:read

POST /api/v1/video/projects

Create a Subscribr Video project

videoCreateVideo · video:generate

GET /api/v1/video/projects/{project}

Get a Subscribr Video project

videoGetProject · video:read

GET /api/v1/video/projects/{project}/download

Get a Subscribr Video project's download URL

videoGetProjectDownload · video:read

GET /api/v1/video/projects/{project}/editable-content

Get a Subscribr Video project's editable Review & Fix content

videoGetEditableContent · video:read

GET /api/v1/video/projects/{project}/revision-manifest

Get a Subscribr Video project's revision manifest

videoGetRevisionManifest · video:read

GET /api/v1/video/projects/{project}/overlay-templates

List overlay templates available for a Subscribr Video project

videoListOverlayTemplates · video:read

GET /api/v1/video/projects/{project}/quality-report

Get a Subscribr Video project's latest quality report

videoGetQualityReport · video:read

GET /api/v1/video/projects/{project}/revision/passes/{pass}

Get one Subscribr Video revision pass

videoGetRevisionPass · video:read

POST /api/v1/video/projects/{project}/revision/overlays

Add a staged overlay to a Subscribr Video revision

videoAddOverlay · video:edit

DELETE /api/v1/video/projects/{project}/revision/overlays/{item}

Remove a staged overlay from a Subscribr Video revision

videoRemoveStagedOverlay · video:edit

PATCH /api/v1/video/projects/{project}/revision/published-overlays/{overlay}

Update a published overlay in a Subscribr Video revision

videoUpdateOverlay · video:edit

DELETE /api/v1/video/projects/{project}/revision/published-overlays/{overlay}

Remove a published overlay from a Subscribr Video revision

videoRemoveOverlay · video:edit

PUT /api/v1/video/projects/{project}/revision/captions

Update caption settings in a Subscribr Video revision

videoUpdateCaptions · video:edit

PUT /api/v1/video/projects/{project}/revision/music

Update background music removal in a Subscribr Video revision

videoRemoveMusic · video:edit

PATCH /api/v1/video/projects/{project}/revision/slide-text

Edit slide text in a Subscribr Video revision

videoEditSlideText · video:edit

PUT /api/v1/video/projects/{project}/revision/regenerate-visual

Regenerate a visual block in a Subscribr Video revision

videoRegenerateVisual · video:edit

PUT /api/v1/video/projects/{project}/revision/replace-with-media

Replace a visual block with a media-library asset in a Subscribr Video revision

videoReplaceWithMedia · video:edit

PUT /api/v1/video/projects/{project}/revision/presenter

Switch a visual block to the presenter in a Subscribr Video revision

videoShowPresenter · video:edit

DELETE /api/v1/video/projects/{project}/revision/items/{item}

Discard a staged edit from a Subscribr Video revision

videoDiscardEdit · video:edit

POST /api/v1/video/projects/{project}/revision/apply

Apply a Subscribr Video revision and publish a new version

videoApplyRevision · video:publish

POST /api/v1/video/projects/quote

Quote a Subscribr Video generation

videoQuoteVideo · video:generate

POST /api/v1/video/projects/{project}/cancel

Cancel a Subscribr Video project

videoCancelVideo · video:generate

GET /api/v1/channels/{channel}/voices

List Channel Voices

listChannelVoices · voices:read

POST /api/v1/channels/{channel}/voices/validate

Validate and canonicalize a complete Voice Profile v2 without mutating data

validateVoiceProfile · voices:write

POST /api/v1/channels/{channel}/voices/commit

Commit an exactly validated Voice Profile receipt

commitVoiceProfile · voices:write

GET /api/v1/channels/{channel}/voices/{voice}

Get a Channel Voice Profile

getVoiceProfile · voices:read

GET /api/v1/webhooks

List Webhooks

listWebhooks · webhooks:read

POST /api/v1/webhooks

Create Webhook

createWebhook · webhooks:write

GET /api/v1/webhooks/{webhook}

Get Webhook

getWebhook · webhooks:read

PUT /api/v1/webhooks/{webhook}

Update Webhook

updateWebhook · webhooks:write

DELETE /api/v1/webhooks/{webhook}

Delete Webhook

deleteWebhook · webhooks:write

POST /api/v1/webhooks/{webhook}/test

Test Webhook

testWebhook · webhooks:write