InícioReferência da API
Referencia apiLive streams

Clipes Live Agendamento Novo

POST
/v1/live-streams/{key}/clip/schedule

POST /v1/live-streams/{key}/clip/schedule. Contrato do handler clipesLiveAgendamentoNovo. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT de usuário/console ou API token, conforme a autorização e as permissões da conta. Não enviar tokens reais nos exemplos.

Parâmetros de path

key*string

Identificador utilizado pelo handler.

Parâmetros de query

preset?string

Corpo da requisição

application/json
  1. body
captionBlur?number
Intervalo0 <= value
captionEffect?string
Valor em"scale""bounce""caixa""nenhum"
captionFont?string
captionHighlight?string
captionLines?integer
Intervalo0 <= value
captionMargin?integer
Intervalo0 <= value
captionPrimary?string
captionShadowX?integer
captionShadowY?integer
captionSize?integer
Intervalo0 <= value
captionStroke?number
Intervalo0 <= value
captionUppercase?boolean
directoryId?string
durationMinutes*integer
Intervalo1 <= value
focus?boolean
format?string
Valor em"9:16""1:1""4:5""16:9""tiktok""reels""instagram"
framing?string
Valor em"tight""sharp"
headline?boolean
headlineBgColor?string
headlineDuration?number
Intervalo0 < value
headlineEffect?string
Valor em"nenhum""dissolve""direita""esquerda"
headlineEffectDuration?number
Intervalo0 <= value <= 2
headlineFont?string
headlineMarginH?integer
Intervalo-1 <= value
headlineMarginV?integer
Intervalo0 <= value
headlinePaddingH?integer
Intervalo0 <= value
headlinePaddingV?integer
Intervalo0 <= value
headlineRadius?integer
Intervalo0 <= value
headlineSize?integer
Intervalo0 <= value
headlineTextColor?string
headlineUppercase?boolean
headlineWidthPct?integer
Intervalo1 <= value <= 100
identificacao?string
layout?array<>
maxClips?integer
Intervalo2 <= value <= 40
maxLen?integer
Intervalo1 <= value
minClips?integer
Intervalo2 <= value
minLen?integer
Intervalo1 <= value
prompt?string
Comprimento0 <= length <= 1000
startAt*string
subtitles?boolean
type?string
Valor em"gerar""reformatar"
vinhetaFim?
vinhetaInicio?
watermarks?array<>

Corpo da resposta

Operação concluída.

application/json
  1. response
createdAt?string
Formatodate-time
durationMinutes?integer
endedAt?string
Formatodate-time
identificacao?string
jobsCreated?integer
liveKey?string
nextWindowEnd?string
Formatodate-time
nextWindowStart?string
Formatodate-time
parameters?
preset?string
reason?string
scheduleId?string
startAt?string
Formatodate-time
status?string
type?string
curl -X POST "https://example.com/v1/live-streams/0123456789abcdefghijklmnopq/clip/schedule" \  -H "Content-Type: application/json" \  -d '{    "captionBlur": 0,    "captionEffect": "scale",    "captionFont": "",    "captionHighlight": "",    "captionLines": 0,    "captionMargin": 0,    "captionPrimary": "",    "captionShadowX": 0,    "captionShadowY": 0,    "captionSize": 0,    "captionStroke": 0,    "captionUppercase": false,    "directoryId": "0123456789abcdefghijklmnopq",    "durationMinutes": 1,    "focus": false,    "format": "9:16",    "framing": "tight",    "headline": false,    "headlineBgColor": "",    "headlineDuration": 1,    "headlineEffect": "nenhum",    "headlineEffectDuration": 0,    "headlineFont": "",    "headlineMarginH": -1,    "headlineMarginV": 0,    "headlinePaddingH": 0,    "headlinePaddingV": 0,    "headlineRadius": 0,    "headlineSize": 0,    "headlineTextColor": "",    "headlineUppercase": false,    "headlineWidthPct": 1,    "identificacao": "",    "maxClips": 2,    "maxLen": 1,    "minClips": 2,    "minLen": 1,    "prompt": "",    "startAt": "exemplo",    "subtitles": false,    "type": "gerar",    "vinhetaFim": {      "duracao": 1,      "encaixe": "letterbox",      "fonte": "exemplo",      "transicao": ""    },    "vinhetaInicio": {      "duracao": 1,      "encaixe": "letterbox",      "fonte": "exemplo",      "transicao": ""    }  }'
{  "createdAt": "2026-01-15T12:00:00Z",  "durationMinutes": 0,  "endedAt": "2026-01-15T12:00:00Z",  "jobsCreated": 0,  "liveKey": "0123456789abcdefghijklmnopq",  "nextWindowEnd": "2026-01-15T12:00:00Z",  "nextWindowStart": "2026-01-15T12:00:00Z",  "parameters": {    "captionBlur": 0,    "captionEffect": "",    "captionFont": "",    "captionHighlight": "",    "captionLines": 0,    "captionMargin": 0,    "captionPrimary": "",    "captionShadowX": 0,    "captionShadowY": 0,    "captionSize": 0,    "captionStroke": 0,    "captionUppercase": false,    "directoryId": "0123456789abcdefghijklmnopq",    "focus": false,    "format": "",    "framing": "",    "headline": false,    "headlineBgColor": "",    "headlineDuration": 0,    "headlineEffect": "",    "headlineEffectDuration": 0,    "headlineFont": "",    "headlineMarginH": 0,    "headlineMarginV": 0,    "headlinePaddingH": 0,    "headlinePaddingV": 0,    "headlineRadius": 0,    "headlineSize": 0,    "headlineTextColor": "",    "headlineUppercase": false,    "headlineWidthPct": 0,    "maxClips": 0,    "maxLen": 0,    "minClips": 0,    "minLen": 0,    "prompt": "",    "subtitles": false,    "vinhetaFim": {      "duracao": 0,      "encaixe": "",      "fonte": "",      "transicao": ""    },    "vinhetaInicio": {      "duracao": 0,      "encaixe": "",      "fonte": "",      "transicao": ""    }  },  "scheduleId": "0123456789abcdef01234567",  "startAt": "2026-01-15T12:00:00Z",  "status": "",  "type": ""}

Clipes Live Agendamento Buscar GET

GET /v1/live-streams/{key}/clip/schedule. Contrato do handler clipesLiveAgendamentoBuscar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Clipes Live Agendamento Cancelar DELETE

DELETE /v1/live-streams/{key}/clip/schedule. Contrato do handler clipesLiveAgendamentoCancelar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.