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
pageelimitnas listagens, comtotalna resposta.
Mapa de endpoints
Vídeo
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /meta | Buscar metadados de uma URL |
| POST | /upload | Upload de arquivo de vídeo |
Projetos
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /projects | Listar projetos |
| GET | /projects/:id | Detalhe do projeto |
| POST | /projects | Criar projeto |
| DELETE | /projects/:id | Excluir projeto |
| POST | /projects/:id/cancel | Cancelar processamento |
| GET | /projects/:id/status | Status em tempo real (SSE) |
Templates de legenda
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /caption-templates | Listar templates |
| GET | /caption-templates/:id | Buscar template |
| POST | /caption-templates | Criar template |
| PUT | /caption-templates/:id | Atualizar template |
| DELETE | /caption-templates/:id | Excluir template |
Clipes e agendamento
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /clips/:clipId/schedule | Agendar clipe |
| GET | /clips/scheduled | Listar agendamentos |
| POST | /projects/:id/bulk-schedule | Agendar em lote |
Integrações
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /integrations | Listar integrações |
| DELETE | /integrations/:id | Remover integração |
Créditos e assinatura
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /credits | Saldo e plano |
| POST | /credits/select-plan | Selecionar plano |
| POST | /stripe/checkout | Checkout Stripe |
| POST | /stripe/customer-portal | Portal do cliente |
Conta
| Método | Endpoint | Descrição |
|---|---|---|
| PUT | /auth/profile | Atualizar perfil |
| PUT | /auth/avatar | Enviar avatar |
| DELETE | /auth/avatar | Remover avatar |
Notificações
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /notifications | Listar notificações |
| POST | /notifications/read | Marcar todas como lidas |
| POST | /notifications/:id/read | Marcar como lida |
Configuração
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /config | Configuração pública do app (ex.: modelo Whisper ativo) |
Comece por: Autenticação · Erros e convenções · Criar um projeto