API de Singing Pet

Inicio rápido

Crea una clave, elige una canción, envía una URL de la foto. Tres llamadas.

# 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"

Autenticación

Envía tu clave como un token de portador (bearer token) en cada solicitud. Si prefieres no guardar una clave, la API también acepta tokens de acceso OAuth 2.1, con registro de cliente dinámico abierto y PKCE.

Créditos

Los créditos son prepagados y nunca caducan. Un crédito genera un video. Un renderizado que falla se reembolsa automáticamente, por lo que no es necesario volver a crear un video para recuperar el crédito.

Endpoints

Cada endpoint bajo /v1 requiere una clave API o un token OAuth. La referencia completa, incluyendo los esquemas de solicitud y respuesta, se encuentra en el documento OpenAPI.

Errores

Cada error es JSON con un código estable, un mensaje y una pista sobre qué hacer al respecto. Nada devuelve una página de error 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"
}