API di Singing Pet

Guida rapida

Crea una chiave, scegli una canzone, invia l'URL di una foto. Tre chiamate.

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

Autenticazione

Invia la tua chiave come bearer token in ogni richiesta. Se preferisci non gestire una chiave, l'API accetta anche token di accesso OAuth 2.1, con registrazione dinamica del client e PKCE.

Crediti

I crediti sono prepagati e non scadono mai. Un credito genera un video. Un rendering che fallisce viene rimborsato automaticamente, quindi non c'è bisogno di ricreare un video per recuperare il credito.

Endpoint

Ogni endpoint sotto /v1 accetta una chiave API o un token OAuth. Il riferimento completo, inclusi gli schemi di richiesta e risposta, si trova nel documento OpenAPI.

Errori

Ogni errore è in formato JSON con un codice stabile, un messaggio e un suggerimento su cosa fare al riguardo. Nulla restituisce una pagina di errore 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"
}