ShowBits API
Mit der REST-API greifen eigene Systeme auf einen Arbeitsbereich zu: Folgen hochladen und importieren, Clips bearbeiten, freigeben, planen und posten, Brand Kits, Team und Webhooks. Sie steht in den Tarifen Enterprise und OnPremise zur Verfügung.
Basisadresse https://app.showbits.ai/api/v1 · OpenAPI 3.1
Für n8n, Zapier und Make in jedem Tarif, ohne die API: ShowBits-Automationen.
Anmeldung
Jede Anfrage trägt ein Token aus Einstellungen → API: Authorization: Bearer sbk_…. Ein Token gehört einer Person und einem Arbeitsbereich und handelt dort als diese Person, mit ihrer Rolle; seine Berechtigungen (Scopes) schränken weiter ein. Widerrufen wirkt sofort.
Fehler
Fehler kommen als application/problem+json (RFC 9457) mit reason, einem festen Wort zum Verzweigen: 401 ohne gültiges Token, 403 fehlende Berechtigung oder Rolle, 404 unbekannt oder in einem anderen Arbeitsbereich, 409 Zustand (etwa notApproved, embargo), 413 Datei zu groß, 422 Eingabe, 429 Grenze oder Kontingent.
Seiten
Listen liefern { data, nextCursor }; mit ?cursor= geht es weiter, ?limit= bis 200 (Standard 50).
Grenzen
Je Token und Minute 600 lesende und 60 schreibende Anfragen; die Kopfzeilen RateLimit-Limit, RateLimit-Remaining und RateLimit-Reset zeigen den Stand, darüber kommt 429 mit Retry-After. KI-Aufgaben und Uploads zählen gegen das Kontingent der Organisation.
Wiederholen ohne doppelt
Ein POST darf Idempotency-Key tragen: Je Token und Schlüssel läuft er 24 Stunden lang einmal; dieselbe Anfrage bekommt die gespeicherte Antwort (Idempotent-Replayed: true), eine andere mit demselben Schlüssel 422.
Versionen
/v1 ändert sich nur, indem etwas dazukommt: neue Felder, Routen und Ereignisse. Unbekannte Felder in Antworten bitte übergehen; unbekannte Felder in Anfragen lehnt die API ab.
Webhooks
Webhooks legen Admins in Einstellungen → API oder über …/webhooks an. Jedes Ereignis kommt als POST mit ShowBits-Event, ShowBits-Delivery und ShowBits-Signature: t=…,v1=… (HMAC-SHA256 über t.body mit dem Geheimnis). Prüfen Sie die Signatur und verwerfen Sie Zeitstempel älter als fünf Minuten; Wiederholungen erkennen Sie an der id im Inhalt. Ereignisse nennen Objekte nur per ID.
import { createHmac, timingSafeEqual } from "node:crypto";
// header: the ShowBits-Signature header; body: the raw request body; secret: whsec_…
export function verify(header, body, secret, toleranceSec = 300) {
const parts = header.split(",").map((p) => p.trim().split("="));
const t = Number(parts.find(([k]) => k === "t")?.[1]);
if (!Number.isInteger(t) || Math.abs(Date.now() / 1000 - t) > toleranceSec) return false;
const expected = createHmac("sha256", secret).update(`${t}.${body}`).digest();
return parts.some(([k, v]) => k === "v1" && v?.length === 64 && timingSafeEqual(Buffer.from(v, "hex"), expected));
}Routen
Account
get/v1/meThe token's person and workspace
Jedes gültige Token
200The person ·Account401Problem details (RFC 9457)403Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/installationThis installation
Jedes gültige Token
200Cloud or OnPremise ·Installation401Problem details (RFC 9457)403Problem details (RFC 9457)429Problem details (RFC 9457)
Workspaces
get/v1/workspacesThe token's workspace
Berechtigung workspaces:read
200One workspace: a token belongs to one ·object401Problem details (RFC 9457)403Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}A workspace
Berechtigung workspaces:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200The workspace ·Workspace401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/meThe token's person in the workspace, with their role
Berechtigung workspaces:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Role and organisation ·Membership401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/showsThe workspace's shows
Berechtigung workspaces:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Shows ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/shows/{id}/embargo-ruleThe embargo rule of a show's new episodes (workspace admins)
Berechtigung settings:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
rule*object | null– null: the organisation's default
200The show ·Show401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/whitelabelThe workspace's white label (workspace admins)
Berechtigung settings:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
enabledbooleandomainstringemailSenderstringthemeBrandKitIdstring | null
200The white label ·Whitelabel401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/statsThe overview's numbers
Berechtigung workspaces:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Numbers ·Stats401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
Episodes
get/v1/workspaces/{ws}/episodesEpisodes, newest first
Berechtigung episodes:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
limit | query | integer | |
cursor | query | string | |
status | query | all | processing | ready | published | |
q | query | string | Words in the title |
200A page of episodes ·EpisodePage401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/episodes/{id}An episode
Berechtigung episodes:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The episode ·Episode401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/episodes/{id}Delete an episode with its clips, posts and uploaded file
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/episodes/{id}Change an episode's format, link or show
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
formattalk | reality | livestream | broll | null– What the episode is; null hands it back to the recognitionlinkstring | null– The episode's own link (https); null removes itshowIdstring– Another show, while the episode is uploaded or processed
200The episode ·Episode401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/episodes/{id}/transcriptAn episode's transcript
Berechtigung episodes:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200Lines, by time ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/episodes/{id}/resumeTake up an episode the quota stopped
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The episode, processing again ·Episode401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/episodes/{id}/posterThe episode's small still
Berechtigung episodes:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200WebP ·file401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/episodes/{id}/embargoSet, change or lift an episode's embargo (admins and duty editors)
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
untilstring | null– The new end; null lifts the embargoruletrue– Apply the show's rule againmovePostsboolean– Move posts planned before the new end to it (else 409 postsBefore)
200The embargo now ·EmbargoResult401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/episodes/{id}/postsThe episode's open posts planned before a time
Berechtigung schedule:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string | |
until * | query | string | A possible new embargo end |
200Posts, by time ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
Uploads
post/v1/workspaces/{ws}/uploadsStart uploading a video or audio file
Creates the episode and the bucket's multipart upload. Then sign the parts, PUT each to its URL, and complete.
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
name*stringsize*integertype*string
201Started ·UploadTicket401Problem details (RFC 9457)403Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)503Problem details (RFC 9457)
post/v1/workspaces/{ws}/uploads/{id}/partsSigned URLs for parts (valid for an hour)
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
parts*integer[]progressnumber | null
200One URL per part: PUT the part's bytes to it ·PartUrls401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/uploads/{id}/partsParts the bucket has (to continue an interrupted upload)
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200Part numbers ·StoredParts401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/uploads/{id}/completeAll parts are there: assemble the file and start processing
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The episode at 100 %; the worker takes it up and moves it to processing ·Episode401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/storage/{provider}/filesFolders and video or audio files in a connected storage
Berechtigung storage:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
provider * | path | googleDrive | oneDrive | box | dropbox | mam | |
folder | query | string | |
view | query | root | shared | |
search | query | string | |
page | query | string | nextPage of the previous answer |
200A listing ·StorageListing401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)
post/v1/workspaces/{ws}/importsA new episode from a file in a connected storage (read in place)
Berechtigung episodes:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
provider*googleDrive | oneDrive | box | dropbox | mamfileId*string
201The new episode ·Imported401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)
put/v1/workspaces/{ws}/storage/{provider}/import-folderThe folder imports start from (admins)
Berechtigung settings:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
provider * | path | googleDrive | oneDrive | box | dropbox | mam |
Inhalt (JSON)
folderId*string | null
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/watch-foldersFolders watched for new files
Berechtigung storage:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Watched folders ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/watch-foldersWatch a folder (admins)
Files in the folder now stay as they are; every video or audio file that arrives later becomes an episode of the show once its size has stayed the same for ten minutes. Only the folder itself, not its subfolders. At most 10 per workspace.
Berechtigung settings:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
provider*googleDrive | oneDrive | box | dropbox | mamfolderId*stringshowIdstring | null– The show new episodes belong to; null: the workspace's first
201The watched folder ·WatchFolder401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)
delete/v1/workspaces/{ws}/watch-folders/{id}Stop watching a folder (admins)
Berechtigung settings:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
Clips
get/v1/workspaces/{ws}/clipsClips and quote cards
Berechtigung clips:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
limit | query | integer | |
cursor | query | string | |
episodeId | query | string | |
status | query | review | approved | scheduled | published | rejected |
200A page of clips ·ClipPage401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/clips/{id}A clip with its texts and settings
Berechtigung clips:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The clip ·Clip401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/clips/{id}Change a clip: title, cut, format, channels, texts, hashtags, a quote card's text
A new cut or format renders the video again. A released quote card changes only after it is sent for approval again (POST …/submit).
Berechtigung clips:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
titlestringsettingsobjectchannelsyoutube | instagram | facebook | tiktok | linkedin | x[]copyobjecthashtagsstring[]channelHashtagsobjectcutobjectquoteobject
200The clip ·Clip401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/clips/{id}Delete a clip with its texts, approvals and planned posts
Berechtigung clips:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/clips/{id}/videoThe clip's video
Berechtigung clips:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string | |
download | query | true | false | true: the link downloads the file |
302Redirects to a short-lived link to the file (one hour)401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/clips/{id}/thumbnailThe clip's thumbnail, or a quote card's picture
Berechtigung clips:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string | |
download | query | true | false | true: the link downloads the file |
format | query | 16x9 | 9x16 | 4x5 | 1x1 | Clips: 16x9 or the 9x16 cover; quote cards: 4x5, 9x16, 1x1 |
302Redirects to a short-lived link to the file (one hour)401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/clips/{id}/subtitlesThe clip's subtitles (WebVTT)
Berechtigung clips:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
302Redirects to a short-lived link to the file (one hour)401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/subtitle-languagesLanguages subtitles can be translated into
Jedes gültige Token
200BCP 47 codes ·Languages401Problem details (RFC 9457)403Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/clips/{id}/submitSend a clip into the first approval step
Berechtigung clips:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The clip, in review ·Clip401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/clips/{id}/stillThe clip's clean still, without headline
Berechtigung clips:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200WebP ·file401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
Approval
post/v1/workspaces/{ws}/clips/{id}/approveApprove one step
The last step releases the clip for planning and posting. In the token's person's name; the audit log names the token.
Berechtigung clips:approve
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
commentstring– Shown in the approval history
200Released, or forwarded to the next step ·ApprovalOutcome401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/clips/{id}/rejectSend a clip back for changes
Berechtigung clips:approve
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
commentstring– Shown in the approval history
200The clip ·Clip401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/episodes/{id}/approve-allMove every clip of an episode in review one approval step forward
Berechtigung clips:approve
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200How many moved ·Count401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
AI
get/v1/workspaces/{ws}/ai/statusWho would run each AI task now
Berechtigung integrations:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200A provider and model per task, or null ·AiStatus401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/clips/{id}/copy-suggestionsTexts and hashtags per channel, in the brand's voice (nothing is saved)
Berechtigung ai:run
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
channelsyoutube | instagram | facebook | tiktok | linkedin | x[]– Default: the clip's channels
200Suggestions ·CopySuggestions401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)503Problem details (RFC 9457)
post/v1/workspaces/{ws}/clips/{id}/translationsTranslate the clip's subtitle and store it for that language
Berechtigung ai:run
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
language*string– BCP 47, one of GET /v1/subtitle-languages
200The translation ·Translation401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)503Problem details (RFC 9457)
post/v1/workspaces/{ws}/episodes/{id}/headlinesThumbnail headlines for the episode's first clips (stored)
Berechtigung ai:run
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200How many ·Headlines401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)503Problem details (RFC 9457)
post/v1/workspaces/{ws}/episodes/{id}/analysisAnalyse the transcript again: format, highlights, memes, clips
Berechtigung ai:run
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200What it found ·Analysis401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)503Problem details (RFC 9457)
post/v1/workspaces/{ws}/episodes/{id}/quote-searchLook for quote cards in the episode
Berechtigung ai:run
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200New quote cards ·QuoteSearch401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)503Problem details (RFC 9457)
Posts
get/v1/workspaces/{ws}/postsPlanned and published posts in a time range
Berechtigung schedule:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
from | query | string | Default: 30 days ago |
to | query | string | Default: 120 days after from; at most 400 days after from |
200Posts, by time ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/clips/{id}/postsA clip's posts
Berechtigung schedule:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200Posts, by time ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/clips/{id}/postsPlan an approved clip on channels
A channel planned already moves to its new time.
Berechtigung schedule:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
times*object[]inSync*boolean– All channels at one time (the first entry's); moving one post later moves all
200The clip's posts ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/channelsChannels ShowBits posts to by itself right now
Berechtigung schedule:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Connected channels ·Channels401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/posts/{id}Take a planned post off the plan
Berechtigung schedule:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/posts/{id}Move a post to a new time
A clip planned in sync moves all its open posts.
Berechtigung schedule:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
publishAt*string
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/posts/{id}/mark-publishedMark a post put online by hand as published
Berechtigung schedule:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/posts/{id}/youtube-optionsA YouTube post's own visibility and statements
Berechtigung schedule:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
options*object | null– null: as the show's brand kit says
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/posts/{id}/retrySend a failed post again
Berechtigung schedule:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/clips/{id}/publishPost a released clip now on connected channels
Berechtigung posts:publish
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
channels*youtube | instagram | facebook | tiktok | linkedin | x[]– Connected channels (GET …/channels)
200Posts under way ·PostCount401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/posts/{id}/removeTake a published post down
Where ShowBits posted it, ShowBits deletes it on the platform (removing, then removed).
Berechtigung posts:publish
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
hereboolean– true: the post was deleted on the platform by hand; only the plan forgets it
200State ·Removal401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
Brand kits
get/v1/workspaces/{ws}/brand-kitsThe workspace's brand kits
Berechtigung brand:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Brand kits ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/brand-kitsA new brand kit (workspace admins)
Berechtigung brand:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
name*string
201The brand kit ·BrandKit401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/brand-kits/{id}Change a brand kit (workspace admins)
Berechtigung brand:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
namestringprimarystringaccentstringheadingFontPlus Jakarta Sans | Geist | Inter | Source Serif 4 | ownbodyFontPlus Jakarta Sans | Geist | Inter | Source Serif 4 | ownsubtitleStyleclean | marker | bold | shadowtonestringlogoInVideobooleanlogoPlacementobjectsubtitleTemplateobjectcardTemplateobject | nulllistenUrlstring | nulllinkedinobjectyoutubeobject
200The brand kit ·BrandKit401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/brand-kits/{id}/logoStore the logo (PNG or SVG, at most 512 KB); an empty body removes it
Berechtigung brand:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt: die Datei selbst (image/png, image/svg+xml); ein leerer Inhalt entfernt sie.
200The brand kit ·BrandKit401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)413Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/brand-kits/{id}/logoThe logo's file
Berechtigung brand:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200PNG or SVG ·file401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/brand-kits/{id}/fontStore the kit's own font (TTF or OTF, at most 2 MB) as its heading font; an empty body removes it
Berechtigung brand:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt: die Datei selbst (font/ttf, font/otf, application/octet-stream); ein leerer Inhalt entfernt sie.
200The brand kit ·BrandKit401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)413Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/brand-kits/{id}/fontThe own font's file
Berechtigung brand:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200TTF or OTF ·file401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/brand-kits/{id}/card-imageStore the card template's picture (JPEG, at most 2 MB); an empty body removes it
Berechtigung brand:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt: die Datei selbst (image/jpeg); ein leerer Inhalt entfernt sie.
200The brand kit ·BrandKit401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)413Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/brand-kits/{id}/card-imageThe card template picture's file
Berechtigung brand:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200JPEG ·file401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/brand-kits/{id}/restyleDraw the kit's clips and quote cards again in its current look (workspace admins)
Berechtigung brand:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
apply*boolean– false: only what would be drawn again; true: do it
200What is (or would be) drawn again ·Restyle401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
Team
get/v1/workspaces/{ws}/membersThe workspace's team, with open invitations
Berechtigung team:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Members ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/seatsPeople of the organisation against the plan's limit
Berechtigung team:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Seats ·Seats401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/members/{id}Change a member's role (workspace admins)
Berechtigung team:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
role*admin | cvd | editor | social
200The member ·Member401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/members/{id}Remove a member or withdraw an invitation (workspace admins)
Berechtigung team:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/invitationsInvite a person by email (workspace admins)
No email goes out: the person signs in with that address and accepts in the app.
Berechtigung team:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
email*stringnamestringrole*admin | cvd | editor | social
201The invitation ·Member401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
Integrations
get/v1/workspaces/{ws}/integrationsIntegrations and their connections
Berechtigung integrations:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Integrations ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/integrations/{id}Disconnect an integration (workspace admins)
Connecting needs the provider's consent in the app.
Berechtigung integrations:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | googleDrive | oneDrive | box | dropbox | youtube | instagram … |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
Settings
get/v1/workspaces/{ws}/editorial-rulesEditorial rules: house terms, blocked words, style guide
Berechtigung settings:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200The rules ·EditorialSettings401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
put/v1/workspaces/{ws}/editorial-rulesReplace the editorial rules (workspace admins, Business and up)
Berechtigung settings:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
terms*object[]blocked*string[]styleGuide*string
200The rules ·EditorialSettings401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/securitySecurity settings and the default embargo
Berechtigung settings:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Settings ·Security401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
Usage
get/v1/workspaces/{ws}/usageMinutes used and included this period
Berechtigung usage:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Usage ·Usage401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/audit-eventsThe audit log, newest first (workspace admins)
Berechtigung audit:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
limit | query | integer |
200Events ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
Webhooks
get/v1/workspaces/{ws}/webhooksThe workspace's webhooks
Berechtigung webhooks:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Webhooks ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/webhooksSubscribe an address to events (workspace admins)
Berechtigung webhooks:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
Inhalt (JSON)
url*string– https, a public addressevents*brand_kit.applied | clip.approved | clip.deleted | clip.delivered | clip.delivery_failed | clip.forwarded …[]descriptionstring
201The webhook and its secret, shown once ·WebhookWithSecret401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/webhooks/{id}Change, pause or resume a webhook
Berechtigung webhooks:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
urlstring– https, a public addresseventsbrand_kit.applied | clip.approved | clip.deleted | clip.delivered | clip.delivery_failed | clip.forwarded …[]descriptionstringpausedboolean– false resumes and forgets the failures
200The webhook ·Webhook401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/webhooks/{id}Delete a webhook
Berechtigung webhooks:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/webhooks/{id}/secretA new secret; the old one signs too for a day
Berechtigung webhooks:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The new secret, shown once ·WebhookSecret401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/webhooks/{id}/testSend a test event (webhook.test), also while paused
Berechtigung webhooks:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
202Queued: the worker sends it within seconds401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/webhooks/{id}/deliveriesA webhook's latest deliveries (30 days), newest first
Berechtigung webhooks:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string | |
limit | query | integer |
200Deliveries ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
Connectors
get/v1/workspaces/{ws}/connectorsThe workspace's connectors (MAM/DAM)
Berechtigung integrations:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Connectors ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
patch/v1/workspaces/{ws}/connectors/{id}Where released clips go (workspace admins)
Each clip goes into <folder>/<episode id>/<clip id>/: video.mp4, subtitles.vtt, thumbnails or card pictures, and clip.json last (docs/connectors.md).
Berechtigung integrations:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | mam |
Inhalt (JSON)
folderIdstring | null– A folder id of the storage (GET …/storage/mam/files); null: clips no longer go thereautoboolean– Released clips go there by themselves
200The connector ·Connector401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)502Problem details (RFC 9457)
get/v1/workspaces/{ws}/deliveriesThe latest deliveries, newest first
Berechtigung integrations:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
clipId | query | string | Only this clip's |
limit | query | integer |
200Deliveries ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/clips/{id}/deliveriesDeliver a released clip (again) to the connectors
Queues the clip for every connector with a delivery folder; the worker sends it within seconds (webhook clip.delivered, or clip.delivery_failed).
Berechtigung clips:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
202Queued ·Delivered401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
Library
get/v1/workspaces/{ws}/libraryReleased clips and quote cards, newest release first
Approved, planned or published. A clip whose episode is still under embargo is listed with embargoUntil; its files stay in ShowBits until then.
Berechtigung library:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
limit | query | integer | |
cursor | query | string | |
kind | query | clip | quote | clip: highlights and memes; quote: quote cards |
q | query | string | Words in the title |
200A page of released clips ·LibraryPage401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/library/{id}A released clip or quote card
Berechtigung library:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
200The clip ·LibraryItem401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/library/{id}/fileOne of a released clip's files
Redirects to a download link valid for an hour; logged as an export. 409 notReleased or embargo, 404 noFile (not there yet, or a variant the clip has not).
Berechtigung library:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string | |
variant | query | video | 16x9 | 9x16 | 4x5 | 1x1 | motion-9x16 … | Clips: video, 16x9, 9x16 (thumbnails); quote cards: 4x5, 9x16, 1x1, and animated motion-9x16, motion-4x5 (MP4 with the speaker's voice, once rendered). Default: the video, a quote card's 4x5 |
302Redirects to a short-lived link to the file (one hour)401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)429Problem details (RFC 9457)
WordPress
get/v1/workspaces/{ws}/wordpress/sitesConnected WordPress sites
Berechtigung integrations:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
200Sites, oldest first ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
delete/v1/workspaces/{ws}/wordpress/sites/{id}End a site's connection (its key too)
Berechtigung integrations:write
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
204Done401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)429Problem details (RFC 9457)
post/v1/workspaces/{ws}/wordpress/sites/{id}/pushesSend released clips into a site's media library
All or nothing: every clip released, its embargo over, its file there; the site fetches them itself. Workspace admins and owners.
Berechtigung posts:publish
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
id * | path | string |
Inhalt (JSON)
clipIds*string[]– Released clips and quote cards, at most 50
200Queued ·Queued401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)409Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)
get/v1/workspaces/{ws}/wordpress/pushesPushes of the last 30 days, newest first
Berechtigung integrations:read
| Parameter | Ort | Typ | Bedeutung |
|---|---|---|---|
ws * | path | string | The workspace's address (slug) |
siteId | query | string | |
clipId | query | string |
200Pushes ·object401Problem details (RFC 9457)403Problem details (RFC 9457)404Problem details (RFC 9457)422Problem details (RFC 9457)429Problem details (RFC 9457)