GET/api/v1/studio/catalog

Catálogo do Studio

Bearer tokenescopo generate:video

Retorna o catálogo vivo do Marketing Studio — a fonte de verdade para montar um request de Vídeo do Studio. Modos, ganchos e cenários são definidos pelo engine em runtime; não os hardcode — leia deste endpoint.

Escopo necessário: generate:video.

Resposta

JSON
{
  "success": true,
  "data": {
    "counts": { "modes": 8, "hooks": 12, "settings": 14 },
    "modes": [
      {
        "slug": "ugc",
        "namePt": "UGC",
        "avatarPolicy": "optional",
        "speechPolicy": "required",
        "hookSettingAllowed": true
      }
    ],
    "hooks": [
      { "id": "clx...", "slug": "product_hit", "namePt": "Produto na Cara", "category": "stunt" }
    ],
    "settings": [
      { "id": "clx...", "slug": "bedroom", "namePt": "Quarto", "category": "normal" }
    ],
    "costsByResolution": { "480p": 130, "720p": 335 }
  }
}

Chaves de uso na geração:

  • modo → identifique pelo campo slug (ex.: ugc, ugc_how_to, product_showcase).
  • gancho e cenário → identifique pelo campo id (não o slug).
  • avatarPolicy (optional / required / forbidden), speechPolicy e hookSettingAllowed governam quais campos são válidos para cada modo — ex.: um modo com speechPolicy: "forbidden" gera vídeo mudo e rejeita userPrompt.
  • costsByResolution → créditos debitados por resolução na geração.

Exemplo de request

cURL
curl https://avatrix.io/api/v1/studio/catalog \
  -H "Authorization: Bearer av_xxxxxxxxxxxxxxxx"

Erros relevantes

CódigoHTTPQuando
FORBIDDEN403token sem generate:video
FEATURE_DISABLED503Marketing Studio indisponível
PROVIDER_UNAVAILABLE503engine do Studio indisponível

Ver Códigos de erro e Escopos.