Singing Pet API

クイックスタート

キーを作成し、曲を選び、写真のURLを送信するだけ。3つのステップで完了です。

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

認証

すべてのリクエストで、キーをベアラートークンとして送信してください。キーを保持したくない場合は、オープンな動的クライアント登録とPKCEを使用したOAuth 2.1アクセストークンも利用可能です。

クレジット

クレジットはプリペイド式で有効期限はありません。1クレジットで1動画をレンダリングできます。レンダリングに失敗した場合は自動的に返金されるため、クレジットを取り戻すために動画を再作成する必要はありません。

エンドポイント

/v1以下のすべてのエンドポイントは、APIキーまたはOAuthトークンを受け付けます。リクエストおよびレスポンスのスキーマを含む完全なリファレンスは、OpenAPIドキュメントで確認できます。

エラー

すべてのエラーは、固定されたコード、メッセージ、および対処法を示すヒントを含むJSON形式で返されます。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"
}