InícioReferência da API
Referencia apiDirectories

Diretorios Listar Itens

GET
/v1/directories/{diretorio_id}/contents

GET /v1/directories/{diretorio_id}/contents. Contrato do handler diretoriosListarItens. 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

diretorio_id*string

Identificador utilizado pelo handler.

Corresponde a^(?:[0-9a-zA-Z]{27})$

Parâmetros de query

directory?string
sub?string
accountId?string
limit?string
page?string
published?string
tags?string
title?string
video_id?string
description?string
type?string
sort?string

Corpo da resposta

Operação concluída.

application/json
  1. response
childrenCount?integer
childrenIds?array<string>
createdAt?string
Formatodate-time
defaultSettings?
fileMapArray?array<>
fullPath?array<string>
fullPathNames?array<>
id?string
inheritSettings?boolean
isDir?boolean
locked?boolean
name?string
normalizedFullPath?string
pagination?
parentId?string
rootFolder?boolean
thumbnailUrl?string
updatedAt?string
Formatodate-time
videoCount?integer
curl -X GET "https://example.com/v1/directories/0123456789abcdefghijklmnopq/contents"
{  "createdAt": "2026-01-15T12:00:00Z",  "defaultSettings": {    "console": {      "useTitleAsFilename": false    },    "live": {      "ads": {        "googleIMA": [],        "vast": [],        "vmap": []      },      "audioOnly": false,      "directoryLive2Vod": "",      "enableDvr": false,      "enableLive2Vod": false,      "endingScreen": "",      "gaTag": "",      "latencyPreference": "",      "lookbackWindow": 0,      "pauseScreen": "",      "playerColor": "",      "preRoll": {        "destinationUrl": "",        "enabled": false,        "skipAfterSeconds": 0,        "skippable": false,        "source": "https://media.example.com/exemplo"      },      "startSoonScreen": "",      "subtitles": false,      "thumbnail": "https://media.example.com/exemplo",      "type": ""    },    "player": {      "autoplay": false,      "enableLikes": false,      "enableOfflineCache": false,      "loop": false,      "overlayLogo": {        "enabled": false,        "logoImage": "https://media.example.com/exemplo",        "position": "",        "url": "https://media.example.com/exemplo"      },      "playbackResume": false,      "playbackSpeeds": [],      "playerCustomization": {        "backgroundColor": "",        "colorTone": "",        "iconTextColor": "",        "playButtonLocation": false,        "primaryColor": "",        "showConfigurations": false,        "showFullscreen": false,        "showLike": false,        "showSeekControls": false,        "showSound": false,        "showSpeed": false,        "showStatistics": false,        "showTitle": false      },      "robotCustomization": {        "assistantAction": [],        "decreaseVolumeActions": [],        "enableVolumeActions": [],        "increaseVolumeActions": [],        "interruptAssistantActions": [],        "interruptionActions": [],        "momentSearchActions": [],        "muteVolumeActions": [],        "playbackActions": [],        "selectedImage": "https://media.example.com/exemplo",        "videoAdvanceActions": [],        "videoRewindActions": [],        "voiceAssistant": false,        "welcomePhrase": ""      },      "rybena": false,      "showClosedCaptions": false,      "showInfoMenu": false,      "showSeekButtons": false,      "showSubtitleSearch": false,      "showSubtitles": false,      "startMuted": false,      "subtitlePosition": "Exemplo sintético"    },    "streaming": {      "geoAccessControl": "",      "geoRegionList": [],      "ipWhitelist": [],      "referrerWhitelist": [],      "streamingProfile": ""    },    "studio": {      "background": false,      "breakout": false,      "chat": false,      "groups": false,      "localization": false,      "locking": false,      "logo": false,      "more_button": false,      "people": false,      "pip_button": false,      "settings_button": false    },    "vod": {      "ads": {        "googleIMA": [],        "vast": [],        "vmap": []      },      "autoCreateSubtitle": false,      "endScreen": "",      "gaTag": "",      "playerColor": "",      "preRoll": {        "destinationUrl": "",        "enabled": false,        "skipAfterSeconds": 0,        "skippable": false,        "source": "https://media.example.com/exemplo"      },      "subtitleConfigs": false,      "subtitleToggle": false,      "thumbnail": "https://media.example.com/exemplo"    }  },  "fileMapArray": [],  "fullPathNames": [],  "id": "0123456789abcdef01234567",  "inheritSettings": false,  "locked": false,  "name": "Exemplo sintético",  "pagination": {    "currentPage": 1,    "currentPageItens": 0,    "itensTotal": 0,    "pageSize": 20,    "pagesTotal": 0  },  "parentId": "0123456789abcdef01234567",  "thumbnailUrl": "https://media.example.com/exemplo",  "updatedAt": "2026-01-15T12:00:00Z"}

Diretorios Deletar DELETE

DELETE /v1/directories/{diretorio_id}. Contrato do handler diretoriosDeletar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Diretorios Mostra Configuracao Padrao GET

GET /v1/directories/{diretorio_id}/settings. Contrato do handler diretoriosMostraConfiguracaoPadrao. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.