Pular para o conteúdo principal

Referência da API

A API REST do SleepComet expõe todos os recursos da plataforma: projetos, clipes, templates, integrações, agendamento e créditos. Este índice apresenta as convenções gerais e o mapa completo de endpoints.

Base URL

https://api.sleepcomet.com/api

Autenticação

Todas as rotas protegidas exigem o header:

Authorization: Bearer <session_token>

O token é o session token do Better Auth, disponível no cookie better-auth.session_token. Detalhes em Autenticação.

Convenções

  • Requisições: JSON (Content-Type: application/json), exceto uploads (multipart/form-data);
  • Respostas: JSON;
  • Erros: { "error": "mensagem" } com o status HTTP apropriado — consulte Erros e convenções;
  • Paginação: parâmetros page e limit nas listagens, com total na resposta.

Mapa de endpoints

Vídeo

MétodoEndpointDescrição
POST/metaBuscar metadados de uma URL
POST/uploadUpload de arquivo de vídeo

Projetos

MétodoEndpointDescrição
GET/projectsListar projetos
GET/projects/:idDetalhe do projeto
POST/projectsCriar projeto
DELETE/projects/:idExcluir projeto
POST/projects/:id/cancelCancelar processamento
GET/projects/:id/statusStatus em tempo real (SSE)

Templates de legenda

MétodoEndpointDescrição
GET/caption-templatesListar templates
GET/caption-templates/:idBuscar template
POST/caption-templatesCriar template
PUT/caption-templates/:idAtualizar template
DELETE/caption-templates/:idExcluir template

Clipes e agendamento

MétodoEndpointDescrição
POST/clips/:clipId/scheduleAgendar clipe
GET/clips/scheduledListar agendamentos
POST/projects/:id/bulk-scheduleAgendar em lote

Integrações

MétodoEndpointDescrição
GET/integrationsListar integrações
DELETE/integrations/:idRemover integração

Créditos e assinatura

MétodoEndpointDescrição
GET/creditsSaldo e plano
POST/credits/select-planSelecionar plano
POST/stripe/checkoutCheckout Stripe
POST/stripe/customer-portalPortal do cliente

Conta

MétodoEndpointDescrição
PUT/auth/profileAtualizar perfil
PUT/auth/avatarEnviar avatar
DELETE/auth/avatarRemover avatar

Notificações

MétodoEndpointDescrição
GET/notificationsListar notificações
POST/notifications/readMarcar todas como lidas
POST/notifications/:id/readMarcar como lida

Configuração

MétodoEndpointDescrição
GET/configConfiguração pública do app (ex.: modelo Whisper ativo)

Comece por: Autenticação · Erros e convenções · Criar um projeto