API de Projetos

A API de Projetos é onde o trabalho começa. Um projeto representa um vídeo de origem que o VDClip transforma em clipes curtos, legendas ou ambos. Você cria um projeto, faz polling até o processamento terminar e então lê os clipes que ele produziu. Esses endpoints permitem listar, criar, consultar e excluir projetos, listar os clipes de um projeto e gerenciar um link público de compartilhamento somente leitura.

Convenções

As requisições usam a URL base https://api.vdclip.com com o cabeçalho Authorization: Bearer vdck_.... A API é apenas servidor a servidor e não tem CORS.

Respostas bem-sucedidas retornam o recurso diretamente. Erros retornam um array errors. Os endpoints de listagem paginam com um cursor mais limit e retornam resultados do mais recente para o mais antigo; siga o cursor retornado. Ler e listar requerem o escopo vdclip:projects:read; criar, excluir e gerenciar links de compartilhamento requerem vdclip:projects:write. Um escopo ausente retorna MISSING_SCOPE.

project_id é um id externo opaco

Todo projeto é endereçado pelo seu project_id, um ULID externo opaco retornado quando você cria o projeto. Trate-o como uma string: nunca o analise, incremente ou derive. Uma requisição para um id desconhecido ou excluído retorna NOT_FOUND.

Endpoints

📂

Listar projetos

GET /v1/projects

VerPagine pelos seus projetos, do mais recente ao mais antigo, com cursor e limit

➕

Criar um projeto de clipagem/legendas

POST /v1/projects

VerInicie um novo projeto a partir de um vídeo de origem

🔎

Obter status e detalhes do projeto

GET /v1/projects/{project_id}

VerFaça polling de um único projeto para obter o status e os detalhes atuais

🎬

Listar os clipes que um projeto produziu

GET /v1/projects/{project_id}/clips

VerLeia os clipes gerados quando o processamento for concluído

🗑️

Excluir um projeto

DELETE /v1/projects/{project_id}

VerRemova um projeto que você não precisa mais

🔗

Obter o link de compartilhamento do projeto

GET /v1/projects/{project_id}/share

VerLeia o link público de compartilhamento somente leitura atual, se houver

✨

Criar um link de compartilhamento do projeto

POST /v1/projects/{project_id}/share

VerGere uma URL pública somente leitura para o projeto

🔄

Regenerar o link de compartilhamento do projeto

POST /v1/projects/{project_id}/share/regenerate

VerGire a URL e invalide a anterior

🚫

Excluir o link de compartilhamento do projeto

DELETE /v1/projects/{project_id}/share

VerRevogue o acesso público removendo o link de compartilhamento