API Singing Pet

Démarrage rapide

Créez une clé, choisissez une chanson, envoyez l'URL d'une photo. Trois appels.

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

Authentification

Envoyez votre clé en tant que jeton porteur (bearer token) sur chaque requête. Si vous préférez ne pas détenir de clé, l'API accepte également les jetons d'accès OAuth 2.1, avec enregistrement dynamique de client ouvert et PKCE.

Crédits

Les crédits sont prépayés et n'expirent jamais. Un crédit génère une vidéo. Un rendu qui échoue est remboursé automatiquement, il n'est donc pas nécessaire de recréer une vidéo pour récupérer le crédit.

Points de terminaison

Chaque point de terminaison sous /v1 accepte une clé API ou un jeton OAuth. La référence complète, incluant les schémas de requête et de réponse, se trouve dans le document OpenAPI.

Erreurs

Chaque erreur est au format JSON avec un code stable, un message et une indication sur la marche à suivre. Rien ne renvoie une page d'erreur 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"
}