Singing Pet API

Schnellstart

Erstellen Sie einen Schlüssel, wählen Sie ein Lied, senden Sie eine Foto-URL. Drei Aufrufe.

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

Authentifizierung

Senden Sie Ihren Schlüssel als Bearer-Token bei jeder Anfrage. Wenn Sie keinen Schlüssel verwenden möchten, akzeptiert die API auch OAuth 2.1-Zugriffstoken mit offener dynamischer Client-Registrierung und PKCE.

Credits

Credits sind im Voraus bezahlt und verfallen nie. Ein Credit rendert ein Video. Ein fehlgeschlagener Render-Vorgang wird automatisch erstattet, sodass Sie kein Video neu erstellen müssen, um den Credit zurückzuerhalten.

Endpunkte

Jeder Endpunkt unter /v1 erfordert einen API-Schlüssel oder ein OAuth-Token. Die vollständige Referenz, einschließlich Anfrage- und Antwort-Schemas, finden Sie im OpenAPI-Dokument.

Fehler

Jeder Fehler ist JSON mit einem stabilen Code, einer Nachricht und einem Hinweis, was zu tun ist. Es werden keine HTML-Fehlerseiten zurückgegeben.

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