Singing Pet API

Szybki start

Utwórz klucz, wybierz piosenkę, wyślij adres URL zdjęcia. Trzy wywołania.

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

Uwierzytelnianie

Wysyłaj swój klucz jako token bearer w każdym żądaniu. Jeśli wolisz nie przechowywać klucza, API akceptuje również tokeny dostępu OAuth 2.1 z otwartą dynamiczną rejestracją klienta i PKCE.

Kredyty

Kredyty są przedpłacone i nigdy nie wygasają. Jeden kredyt to jeden wyrenderowany film. Nieudane renderowanie jest automatycznie zwracane, więc nie ma potrzeby ponownego tworzenia filmu, aby odzyskać kredyt.

Punkty końcowe (Endpoints)

Każdy punkt końcowy w ramach /v1 wymaga klucza API lub tokena OAuth. Pełna dokumentacja, w tym schematy żądań i odpowiedzi, znajduje się w dokumencie OpenAPI.

Błędy

Każdy błąd jest w formacie JSON ze stałym kodem, komunikatem i wskazówką, co z nim zrobić. Nic nie zwraca strony błędu 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"
}