Přehled API
Volávejte Speechdash z vaší vlastní aplikace a vytvářejte API klíče, které ji autorizují.
Speechdash API umožňuje vaší vlastní aplikaci vytvářet dokumenty a generovat řeč pomocí stejných hlasů jako v aplikaci. Vše, co vytvoříte přes API, se také zobrazí ve vaší knihovně. Dokončené audio a video přepisy vytvořené v aplikaci se také objeví jako dokumenty v knihovně (source je transcription, s transcript_id). Neexistuje REST zdroj /transcripts: použijte dokumentové koncové body. API nezačíná úlohy přepisování.
Základní URL:
https://api.speechdash.com/v1Zdravotní kontrola (bez API klíče): GET https://api.speechdash.com/health
Strojově čitelná smlouva je publikována na https://api.speechdash.com/v1/openapi.json, takže si můžete generovat klienta pro váš jazyk.
Koncové body
| Metoda | Cesta | Účel |
|---|---|---|
GET | /health | Zdravotní stav služby (není pod /v1) |
GET | /v1/openapi.json | Dokument OpenAPI 3.1 |
GET | /v1/me | Účet, plán a peněženka |
GET | /v1/documents | Seznam dokumentů v knihovně, včetně dokončených přepisů |
POST | /v1/documents | Vytvoření textového dokumentu (source=api) |
GET | /v1/documents/{document_id} | Čtení dokumentu a jeho textu |
PUT | /v1/documents/{document_id} | Aktualizace názvu, textu, jazyka, is_archived, nebo visibility |
DELETE | /v1/documents/{document_id} | Smazání dokumentu |
POST | /v1/documents/{document_id}/translate | Nová přeložená verze (stejné kredity jako export MP3) |
GET | /v1/documents/{document_id}/export | Stáhněte si pdf, docx, txt, csv, srt, nebo vtt |
POST | /v1/audio/speech | Syntéza až 5 000 znaků (JSON + audio) |
POST | /v1/audio/stream | Stream WAV, až 20 000 znaků |
POST | /v1/audio/stream/with-timestamps | SSE s audio za každý odstavce a značkami |
GET | /v1/voices | Katalog hlasů |
GET | /v1/voices/{voice_id} | Jedna předvolba hlasu |
Interaktivní stránky OpenAPI: Účet, Dokumenty, Audio, Hlasy.
MCP server (pro asistenty AI)
Pokud používáte Cursor, Claude Desktop nebo jinou MCP klientku, můžete přidat oficiální MCP server Speechdash namísto toho, abyste volali HTTP sami. Exponuje stejnou knihovnu (včetně dokončených přepisů), překlad, export, hlasy, snímek účtu a ne-streamující syntézu řeči jako nástroje, které jsou podporovány stejnými API klíči a fakturací jako v tomto průvodci. Streamující řeč zůstává na REST.
Podívejte se na MCP server pro kompletní seznam nástrojů a nastavení (stdio nebo Streamable HTTP). Můžete také přečíst Agents hub na marketingové stránce pro strojově čitelné dokumenty zaměřené na systémy AI. Koncové uživatelé mohou začít z API klíčů a MCP v tomto Help Centeru.
Vytvoření API klíče
Otevřete Nastavení → API.
Klikněte na Nový klíč a dejte mu název, který popisuje, kde bude použit, například Produkční server.
Okamžitě zkopírujte klíč. Uloženo je pouze jeho prefix, takže se zobrazí jednou a nikdy více.
Klíč působí na váš účet. Uchovávejte jej na vašem serveru, nikdy v prohlížeči, mobilní aplikaci nebo veřejném repozitáři. Pokud klíč unikne, zrušte jej z Nastavení → API a vytvořte nový.
Můžete mít až 10 aktivních klíčů, přejmenovat je kdykoli a vidět, kdy byl každý naposledy použit. Zrušení klíče okamžitě zastaví jeho požadavky.
Autentizace požadavku
Odeslete klíč jako token typu bearer:
curl https://api.speechdash.com/v1/me \
-H "Authorization: Bearer sh_live_your_key"Požadavky bez platného klíče odpovídají 401 s kódem unauthorized.
GET /me vrací váš identifikátor účtu, email, plán a zůstatek peněženky (wallet_cents a display_credits), spolu s metadata o použitém API klíči. Použijte jej k ověření klíče po nastavení (například v Zapieru).
POST /documents a POST /audio/speech přijímají volitelný header Idempotency-Key. Opakování stejného klíče se stejným tělem přehrá první úspěšnou odpověď po dobu 24 hodin, takže malá sítová porucha nevyvolá druhý dokument nebo neúčtuje řeč dvakrát. Pokud je odpověď řeči příliš velká na to, aby se uložila, opakování s tímž klíčem odpoví 409 místo regenerace (původní požadavek byl již účtován). Odpojení klienta na /audio/speech odpoví 204, vyúčtuje jakékoli již vytvořené audio a uvolní klíč, takže opakování může regenerovat. Streamovací koncové body audio odmítají tento header.
Kredity
Syntéza řeči spotřebovává kredity z téže peněženky jako aplikace: 0,5 kreditu (1 cent peněženky) za každých 30 sekund generovaného audio. Každý požadavek drží odhad (plus malý marginál) před zahájením generování, poté se vyúčtuje na základě skutečně vytvořeného audio. Nevyužitý odhad se vrátí; každý vyúčtovaný požadavek se zobrazí v Nastavení → Použití kreditů jako API syntéza řeči. Pole billed_credits v odpovědích API je v centech peněženky (2 ceny = 1 zobrazený kredit). Pokud je stream přerušen uprostřed, věty, které byly již dodány, jsou stále účtovány.
Pokud váš zůstatek nedostačuje na pokrytí odhadu, API odpoví 402 s kódem payment_required před generováním něčeho.
Vytváření dokumentů nekonzumuje kredity, ale počítá se do denního limitu dokumentů vašeho plánu (Zdarma: 3 denně; Unlimited: žádný denní limit) a limitů délky nahrávání. Export souborů nekonzumuje kredity.
Účtování vs přehrávání Cloud v aplikaci
Přehrávání Cloud v aplikaci znovu používá cache vět za dokumentem: přehrávání věty, která byla již generována na serveru, může stát 0 zobrazených kreditů. Koncové body REST a MCP pro řeč vždy syntetizují čerstvé audio a účtují za každých 30 sekund zahájené generace stejnou sazbou, když se generace uskuteční. Na API nebo MCP syntéze řeči není žádná cache přehrávání.
Limity
| Limit | Hodnota |
|---|---|
Požadavky na /documents | 120 za minutu, za účet |
Požadavky na /audio/* | 60 za minutu, za účet |
| Souběžné požadavky na řeč | 3 za účet |
POST /audio/speech input | 5 000 znaků |
POST /audio/stream input | 20 000 znaků |
| Text dokumentu | 500 000 znaků |
| Aktivní API klíče | 10 |
Limity požadavků se počítají za účet, nikoli za klíč, takže další klíče nezvýší váš kvótu. Každá odpověď obsahuje X-Request-ID, a /documents a /audio/* také vracejí X-RateLimit-Limit, X-RateLimit-Remaining, a X-RateLimit-Reset. Zveřejňujte X-Request-ID, když kontaktujete podporu.
Požadavky na řeč mají také limit souběžnosti: čtvrtý současný požadavek odpoví 429, dokud tři nejsou ještě v průběhu, takže jedna integrace nemůže monopolizovat syntézu. Opakujte 429 a 503 po Retry-After hlavičce.
Pro obsah delší než limity řeči, vytvořte dokument pomocí POST /v1/documents a exportujte jeho audio z aplikace.
Dokumenty: sdílet, překládat, exportovat
Sérializované dokumenty obsahují visibility a share_url (null při soukromém). PUT /v1/documents/{id} přijímá visibility k publikování neoznačené čtecí stránky na /share/document/{id}, a is_archived k archivování nebo obnově. Sdílené stránky jsou pouze textové. Nehraje se účtované audio.
POST /v1/documents/{id}/translate vytváří novou přeloženou verzi. Účtuje stejnou peněženku kreditů jako export MP3 (0,5 kreditu za každých 30 sekund odhadnuté řeči) a odpoví 402, když peněženka není dostatečná. Odpoví 503, když není nastaven nebo vypnut překlad.
GET /v1/documents/{id}/export?format=pdf|docx|txt|csv|srt|vtt stáhne aktuální verzi jako přílohu. Přidejte timestamps=1, aby se zahrnuly časy sekcí do PDF, DOCX, TXT a CSV. SRT a VTT potřebují přepis nebo úplné časování vět. Uložený text na GET /v1/documents/{id} udržuje hlavičky časových značek přepisu. Skrýt je je pouze nastavení čtecího programu v aplikaci.