Singing Pet API

Snelstart

Maak een sleutel aan, kies een liedje, stuur een foto-URL. Drie aanroepen.

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

Authenticatie

Stuur je sleutel als een bearer token bij elk verzoek. Als je liever geen sleutel gebruikt, accepteert de API ook OAuth 2.1-toegangstokens, met open dynamische clientregistratie en PKCE.

Credits

Credits zijn prepaid en verlopen nooit. Eén credit rendert één video. Een render die mislukt wordt automatisch terugbetaald, dus het is niet nodig om opnieuw een video te maken om de credit terug te krijgen.

Endpoints

Elk endpoint onder /v1 vereist een API-sleutel of een OAuth-token. De volledige referentie, inclusief schema's voor verzoeken en antwoorden, staat in het OpenAPI-document.

Fouten

Elke fout is JSON met een stabiele code, een bericht en een hint over wat je eraan kunt doen. Niets geeft een HTML-foutpagina terug.

{
  "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"
}