Översikt över API
Anropa Speechdash från din egen applikation och skapa API-nycklar som auktoriserar den.
Speechdash API låter din egen applikation skapa dokument och generera tal med samma röster som i appen. Allt du skapar via API visas också i din bibliotek. Avslutade ljud- och videotranskriptioner som skapats i appen visas som biblioteksdokument också (source är transcription, med en transcript_id). Det finns ingen REST-resurs /transcripts: använd dokumentendpunkterna. API:n startar inte transkriptionsjobb.
Bas-URL:
https://api.speechdash.com/v1Hälsokontroll (inga API-nycklar): GET https://api.speechdash.com/health
Den maskinläsbara kontraktet publiceras på https://api.speechdash.com/v1/openapi.json, så du kan generera en klient för ditt språk.
Endpunkter
| Metod | Sökväg | Syfte |
|---|---|---|
GET | /health | Tjänsthälsa (inte under /v1) |
GET | /v1/openapi.json | OpenAPI 3.1-dokument |
GET | /v1/me | Konto, plan och plånbok |
GET | /v1/documents | Lista biblioteksdokument, inklusive avslutade transkriptioner |
POST | /v1/documents | Skapa ett textdokument (source=api) |
GET | /v1/documents/{document_id} | Läsa ett dokument och dess text |
PUT | /v1/documents/{document_id} | Uppdatera titel, text, språk, is_archived eller visibility |
DELETE | /v1/documents/{document_id} | Ta bort ett dokument |
POST | /v1/documents/{document_id}/translate | Ny översatt version (samma poäng som MP3-export) |
GET | /v1/documents/{document_id}/export | Ladda ner pdf, docx, txt, csv, srt eller vtt |
POST | /v1/audio/speech | Synthesera upp till 5 000 tecken (JSON + ljud) |
POST | /v1/audio/stream | Strömma WAV, upp till 20 000 tecken |
POST | /v1/audio/stream/with-timestamps | SSE med per-sats ljud och märken |
GET | /v1/voices | Röstkatalog |
GET | /v1/voices/{voice_id} | En röstförinställning |
Interaktiva OpenAPI-sidor: Konto, Dokument, Ljud, Röster.
MCP-server (för AI-assistenter)
Om du använder Cursor, Claude Desktop eller en annan MCP-klient, kan du lägga till den officiella Speechdash MCP-servern istället för att anropa HTTP direkt. Den exponerar samma bibliotek (inklusive avslutade transkriptioner), översättning, export, röster, konto-snapshot och icke-strömmande talgenerering som verktyg som drivs av samma API-nycklar och fakturering som denna guide. Strömmande tal stannar på REST.
Se MCP-server för fullständig verktygslista och uppsättning (stdio eller Streamable HTTP). Du kan också läsa Agents hub på marknadsplatsen för maskinläsbara dokument riktade till AI-system. Slutanvändare kan börja med API-nycklar och MCP i denna hjälpcenter.
Skapa en API-nyckel
Öppna Inställningar → API.
Klicka på Ny nyckel och ge den ett namn som beskriver var den ska användas, till exempel Produktionsserver.
Kopiera nyckeln omedelbart. Endast dess prefix sparas, så den visas en gång och aldrig mer.
En nyckel påverkar ditt konto. Håll den på din server, aldrig i en webbläsare, en mobilapp eller ett offentligt repository. Om en nyckel läcker, återkalla den från Inställningar → API och skapa en ny.
Du kan ha upp till 10 aktiva nycklar, omdöpa dem när som helst och se när var och en användes senast. Att återkalla en nyckel stoppar dess begär omedelbart.
Autentisera ett begär
Skicka nyckeln som en bärartoken:
curl https://api.speechdash.com/v1/me \
-H "Authorization: Bearer sh_live_your_key"Begär utan en giltig nyckel svarar 401 med koden unauthorized.
GET /me returnerar ditt konto-id, e-post, plan och plånboksbalans (wallet_cents och display_credits), plus metadata om den API-nyckel som användes. Använd det för att verifiera en nyckel efter uppsättningen (till exempel i Zapier).
POST /documents och POST /audio/speech accepterar ett valfritt Idempotency-Key-huvud. Om du upprepar samma nyckel med samma kropp spelar den upp det första lyckade svaret i 24 timmar, så att en nätverksstörning inte skapar ett andra dokument eller fakturerar talet två gånger. Om ett tal-svar är för stort för att sparas, svarar en upprepning med samma nyckel 409 istället för att regenerera (det ursprungliga begäret hade redan fakturerats). Om en klient kopplas från /audio/speech svarar 204, betalar för allt ljud som redan producerats och frigör nyckeln så att en upprepning kan regenerera. Strömmande ljudendpunkter förkastar huvudet.
Poäng
Talgenerering förbrukar poäng från samma plånbok som appen: 0,5 poäng (1 plånbokscent) per startad 30 sekund av genererat ljud. Varje begäran håller en uppskattning (plus en liten marginal) innan generationen börjar, sedan fastställs det till det ljud som faktiskt producerades. Outnyttjad hållning återbetalas; varje fastställd begäran visas i Inställningar → Poänganvändning som API-talgenerering. Fältet billed_credits i API-svaren är plånbokscent (2 cent = 1 displaypoäng). Om en ström avbryts mitt i, så betalas de satser som redan levererats fortfarande.
Om din balans inte kan täcka hållningen, svarar API:n 402 med koden payment_required innan något genereras.
Skapande av dokument förbrukar inte poäng, men det räknas mot din plans dagliga dokumentgräns (Gratis: 3 per dag; Unlimited: ingen daglig gräns) och filupplastningsvaraktighetsbegränsningar. Filexport förbrukar inte poäng.
Fakturering vs Cloud-återspelning i appen
In-app Cloud-återspelning återanvänder per-dokument satsskiva: att återspela en sats som redan genererats på servern kan kosta 0 displaypoäng. REST- och MCP-talendpunkter genererar alltid nytt ljud och fakturerar per startad 30 sekund med samma takt när generationen sker. Det finns ingen återspelningsskiva för API- eller MCP-syntes.
Begränsningar
| Begränsning | Värde |
|---|---|
Begäranden till /documents | 120 per minut, per konto |
Begäranden till /audio/* | 60 per minut, per konto |
| Parallella talbegäranden | 3 per konto |
POST /audio/speech input | 5 000 tecken |
POST /audio/stream input | 20 000 tecken |
| Dokumenttext | 500 000 tecken |
| Aktiva API-nycklar | 10 |
Rate limits räknas per konto, inte per nyckel, så extra nycklar höjer inte din kvot. Varje svar innehåller X-Request-ID, och /documents plus /audio/* returnerar även X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Citerera X-Request-ID när du kontaktar support.
Talbegäranden har också en parallellismbegränsning: en fjärde samtidiga begäran svarar 429 medan tre fortfarande körs, så en integration kan inte monopolisera syntesen. Upprepa 429 och 503 efter Retry-After-huvudet.
För innehåll längre än talbegränsningarna, skapa ett dokument med POST /v1/documents och exportera dess ljud från appen.
Dokument: dela, översätta, exportera
Serialiserade dokument inkluderar visibility och share_url (null när privat). PUT /v1/documents/{id} accepterar visibility för att publicera en olistad läsbar sida på /share/document/{id}, och is_archived för att arkivera eller återställa. Delade sidor är textenbart. De spelar inte fakturerat ljud.
POST /v1/documents/{id}/translate skapar en ny översatt version. Den fakturerar samma plånbok som MP3-export (0,5 poäng per startad 30 sekund av uppskattat tal) och svarar 402 när plånboken är kort. Den svarar 503 när översättning inte är konfigurerad eller är nere.
GET /v1/documents/{id}/export?format=pdf|docx|txt|csv|srt|vtt laddar ner den aktuella versionen som en bilaga. Lägg till timestamps=1 för att inkludera avsnittstider på PDF, DOCX, TXT och CSV. SRT och VTT behöver en transkription eller fullständiga satstider. Lagrad text på GET /v1/documents/{id} behåller transkriptions-tidsstämplar. Att dölja dem är en app-läsartoggle endast.