Skip to main content
POST
Propose live video edit

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this request; reuse it after a timeout to receive the same answer.

Required string length: 1 - 255

Body

application/json

Give at least one of title, description, tags or thumbnailUrl.

videoRef
string
required

The YouTube video id (videos[].videoRef from GET /v1/performance/channels).

Required string length: 6 - 20
title
string

The new title.

Required string length: 1 - 100
description
string

The new description; replaces the current one.

Maximum string length: 5000
tags
string[]

The new tags; replace the current ones.

Maximum array length: 30

One tag.

Required string length: 1 - 60
thumbnailUrl
string<uri>

Public https URL of the new thumbnail (JPEG or PNG).

Maximum string length: 2000
reason
string

Why (for example the diagnosis); kept with the change record.

Maximum string length: 500
projectId
string

Record and run the proposal in this project. Omit to start a workspace conversation.

Required string length: 1 - 200
threadId
string

Continue this Sigma conversation (threadId from an earlier answer) instead of starting one.

Required string length: 1 - 200

Response

Success.

success
boolean
required
threadId
string
required

The Sigma conversation the proposal is recorded in.

messageId
string
required
projectId
string | null
required

Where it runs; null for a workspace conversation until it is approved.

approval
object
required
{key}
any