Przegląd i szybki start

Sketchie zamienia prompt lub dokument w wideo objaśniające na tablicy i zwraca zarówno wyrenderowane wideo, jak i jego edytowalny scene graph. To jest dokumentacja dla HTTP API, CLI, SDK TypeScript i serwera MCP.

Dostęp do API jest wliczony w każdy płatny plan. Utwórz klucz API w Ustawieniach aplikacji, gdy masz już plan. Generowanie przez API pobiera minuty z Twojego planu w tej samej stawce co aplikacja. Nie ma osobnej ceny API.

Uwierzytelnianie

Każde żądanie jest uwierzytelniane Twoim kluczem API jako tokenem Bearer. Utwórz klucz w aplikacji w Ustawieniach, a następnie wyślij go w nagłówku Authorization:

Nagłówek żądania 
Authorization: Bearer sk_...

Klucz jest pokazywany raz, przy tworzeniu. Trzymaj go w tajemnicy. Bazowy adres URL każdego punktu końcowego to https://sketchie.ai/api.

Szybki start

1. Utwórz objaśnienie

Wyślij swój temat jako input i opcjonalną docelową długość jako length (przyjazny ciąg "M:SS", np. "0:30" lub "1:00", w krokach co 30 sekund). Pomiń length, aby uzyskać automatyczną długość.

Terminal 
curl -X POST https://sketchie.ai/api/v1/explainer \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "input": "Explain how DNS resolves a domain name",
    "length": "0:30"
  }'

Wywołanie natychmiast zwraca 202 Accepted z rekordem w kolejce. Renderowanie działa w tle i trwa kilka minut.

202 Accepted 
{
  "id": "10f00eee-d2d6-4a1b-b708-f0391faaa85b",
  "status": "queued",
  "prompt": "Explain how DNS resolves a domain name",
  "lengthSeconds": 30,
  "voice": "sketchie:sulafat",
  "language": "en",
  "aspect": "16:9",
  "videoUrl": null,
  "sceneGraph": null
}

2. Odpytuj o wynik

Pobieraj objaśnienie po id, aż jego status osiągnie stan końcowy. Cykl życia to queued, potem generating, potem rendering, potem ready (gotowe) lub failed.

Terminal 
curl https://sketchie.ai/api/v1/explainer/10f00eee-d2d6-4a1b-b708-f0391faaa85b \
  -H "Authorization: Bearer sk_..."

Gdy jest ready, rekord niesie adres URL wideo i edytowalny scene graph:

200 OK 
{
  "id": "10f00eee-d2d6-4a1b-b708-f0391faaa85b",
  "status": "ready",
  "videoUrl": "https://sketchie.ai/media/....mp4",
  "sceneGraph": { "scenes": [ ... ] }
}

Przyjazne i klasyczne nazwy pól. input i length to przyjazne pola żądania. Starsze prompt (ciąg) i lengthSeconds (liczba, dodatnia wielokrotność 30) są nadal akceptowane jako aliasy, więc istniejące integracje działają dalej. Gdy wysłane są oba, wygrywa pole przyjazne.

Gdzie dalej

  • Dokumentacja API . Każdy punkt końcowy, z kształtami żądania i odpowiedzi.
  • Głosy . Domyślny narrator, katalog sześciu głosów i odtwarzalne podglądy.
  • Języki . 34 obsługiwane języki narracji.
  • CLI i SDK . Wiersz poleceń sketchie i klient TypeScript @sketchie/sdk.
  • Konfiguracja MCP . Używaj Sketchie jako narzędzi w Claude Desktop, Claude Code i aplikacji Claude.