Singing Pet API

Quickstart

Create a key, pick a song, send a photo URL. Three calls.

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

Authentication

Send your key as a bearer token on every request. If you would rather not hold a key, the API also accepts OAuth 2.1 access tokens, with open dynamic client registration and PKCE.

Credits

Credits are prepaid and never expire. One credit renders one video. A render that fails is refunded automatically, so there is no need to re-create a video to get the credit back.

Endpoints

Every endpoint under /v1 takes an API key or an OAuth token. The full reference, including request and response schemas, is in the OpenAPI document.

Errors

Every error is JSON with a stable code, a message, and a hint saying what to do about it. Nothing returns an HTML error page.

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