API do Singing Pet

Início rápido

Crie uma chave, escolha uma música, envie a URL da foto. Três chamadas.

# 1. pick a song
curl https://api.singing.pet/v1/templates \
  -H "Authorization: Bearer $SINGING_PET_KEY"

# 2. queue the render (costs 1 credit)
curl -X POST https://api.singing.pet/v1/videos \
  -H "Authorization: Bearer $SINGING_PET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template_id":"393","image_url":"https://example.com/dog.jpg"}'

# 3. poll until status is completed, about a minute
curl https://api.singing.pet/v1/videos/<id> \
  -H "Authorization: Bearer $SINGING_PET_KEY"

Autenticação

Envie sua chave como um token bearer em cada solicitação. Se preferir não manter uma chave, a API também aceita tokens de acesso OAuth 2.1, com registro dinâmico de cliente aberto e PKCE.

Créditos

Os créditos são pré-pagos e nunca expiram. Um crédito renderiza um vídeo. Uma renderização que falha é reembolsada automaticamente, portanto, não há necessidade de recriar um vídeo para recuperar o crédito.

Endpoints

Cada endpoint em /v1 aceita uma chave de API ou um token OAuth. A referência completa, incluindo esquemas de solicitação e resposta, está no documento OpenAPI.

Erros

Todo erro é um JSON com um código estável, uma mensagem e uma dica sobre o que fazer a respeito. Nada retorna uma página de erro HTML.

{
  "error": {
    "code": "insufficient_credits",
    "message": "Not enough API credits to render a video",
    "status": 402,
    "hint": "Each video costs 1 credit. Buy more at https://singing.pet/dashboard/api-keys.",
    "documentation_url": "https://singing.pet/api"
  },
  "message": "Not enough API credits to render a video"
}