API-overblik

Speechdash API'en tillader din egen applikation at oprette dokumenter og generere tale med de samme stemmer som appen. Alt, hvad du opretter via API'en, vises også i din bibliotek. Færdige audio- og videotransskriptioner, der er oprettet i appen, vises også som biblioteksdokumenter (source er transcription, med en transcript_id). Der er ingen /transcripts REST-resource: brug dokumentendpunkterne. API'en starter ikke transskriptionsopgaver.

Base URL:

https://api.speechdash.com/v1

Helsjekontrol (ingen API-nøgle): GET https://api.speechdash.com/health

Den maskinlæselige kontrakt er offentliggjort på https://api.speechdash.com/v1/openapi.json, så du kan generere en klient til dit sprog.

Endpunkter

Interaktive OpenAPI-sider: Konto, Dokumenter, Audio, Stemmer.

MCP-server (til AI-assistenter)

Hvis du bruger Cursor, Claude Desktop eller en anden MCP-klient, kan du tilføje den officielle Speechdash MCP-server i stedet for at kalde HTTP selv. Den eksponerer samme bibliotek (inklusive færdige transskriptioner), oversættelse, eksport, stemmer, konto-snapshot og ikke-streaming tale-syntese som værktøjer bagved de samme API-nøgler og fakturering som denne guide. Streaming tale forbliver på REST.

Se MCP-server for fuld liste over værktøjer og opsætning (stdio eller Streamable HTTP). Du kan også læse Agents hub på markedsiden for maskinlæselige dokumenter målrettet AI-systemer. Slutbrugere kan starte fra API-nøgler og MCP i denne hjælpeside.

Opret en API-nøgle

Du kan opretholde op til 10 aktive nøgler, omdøbe dem når som helst og se, hvornår hver blev sidst brugt. At ophæve en nøgle stopper dens anmodninger med det samme.

Autentificer en anmodning

Send nøglen som en bærertoken:

curl https://api.speechdash.com/v1/me \
 -H "Authorization: Bearer sh_live_din_nøgle"

Anmodninger uden en gyldig nøgle svarer med 401 og koden unauthorized.

GET /me returnerer din konto-id, e-mail, plan og wallet-balance (wallet_cents og display_credits), samt metadata om den brugte API-nøgle. Brug det til at verifcere en nøgle efter opsætningen (f.eks. i Zapier).

POST /documents og POST /audio/speech accepterer et valgfrit Idempotency-Key-hoved. Gentagelse af samme nøgle med samme krop genoptager den første succesfulde svar i 24 timer, så en midlertidig netværksfejl ikke opretter et andet dokument eller fakturerer tale to gange. Hvis et tale-svar er for stort til at gemmes, svarer en gentagelse med samme nøgle 409 i stedet for at generere igen (den oprindelige anmodning blev allerede faktureret). En klientafbrydelse på /audio/speech svarer 204, afregner eventuel allerede produceret audio og frigiver nøglen, så en gentagelse kan generere igen. Streaming audio-endpunkter afviser hovedet.

Kreditter

Tale-syntese bruger kreditter fra samme wallet som appen: 0,5 kreditter (1 wallet-cent) pr. startet 30 sekunder af genereret audio. Hver anmodning indeholder en estimat (plus en lille margin) før genereringen starter, og afregnes derefter til den faktiske producerede audio. Ubenyttet hold refunderes; hver afregnet anmodning vises i Indstillinger → Kreditbrug som API tale-syntese. billed_credits-feltet i API-svar er wallet-cents (2 cents = 1 display-kredit). Hvis en stream afbrydes midtvejs, faktureres de sætninger, der allerede er leveret, stadig.

Hvis din balance ikke kan dække holdet, svarer API'en 402 med koden payment_required før noget genereres.

Oprettelse af dokumenter bruger ikke kreditter, men det tæller med i din plans daglige dokumentgrænse (Gratis: 3 om dagen; Unlimited: ingen daglig grænse) og filuploadvarighedsbegrænsninger. Fil-eksport bruger ikke kreditter.

Fakturering vs. indbygget Cloud-afspilning

Indbygget Cloud-genafspilning genbruger per-dokument sætningscache: genafspilning af et sætning, der allerede er blevet genereret på serveren, kan koste 0 display-kreditter. REST- og MCP-tale-endpunkter syntetiserer altid frisk audio og fakturerer pr. startet 30 sekunder med samme rate, når genereringen sker. Der er ingen genafspilningscache på API- eller MCP-syntese.

Grænser

Rate-limitter tæller pr. konto, ikke pr. nøgle, så ekstra nøgler øger ikke din kvote. Hvert svar indeholder X-Request-ID, og /documents samt /audio/* returnerer også X-RateLimit-Limit, X-RateLimit-Remaining, og X-RateLimit-Reset. Citer X-Request-ID, når du kontakter support.

Tale-anmodninger har også en parallelismegrænse: en fjerde samtidig anmodning svarer 429, mens tre stadig kører, så en integration ikke kan monopolisere syntesen. Gentag 429 og 503 efter Retry-After-hovedet.

For længere indhold end talegrænserne, opret et dokument med POST /v1/documents og eksporter dets audio fra appen.

Dokumenter: Del, oversæt, eksporter

Serialiserede dokumenter indeholder visibility og share_url (null når privat). PUT /v1/documents/{id} accepterer visibility for at publicere en ulistet læsevenlig side på /share/document/{id}, og is_archived for at arkivere eller genoprette. Delte sider er tekst-baserede. De afspiller ikke faktureret audio.

POST /v1/documents/{id}/translate opretter en ny oversat version. Den fakturerer samme kreditwallet som MP3-eksport (0,5 kreditter pr. startet 30 sekunder af estimeret tale) og svarer 402, når wallet'en er tom. Den svarer 503, når oversættelse ikke er konfigureret eller er ned.

GET /v1/documents/{id}/export?format=pdf|docx|txt|csv|srt|vtt henter den nuværende version som en vedhæftning. Tilføj timestamps=1 for at inkludere afsnitstider på PDF, DOCX, TXT og CSV. SRT og VTT kræver en transskription eller komplette sætnings-tider. Gemt text på GET /v1/documents/{id} bevarer transskriptions-tidsstempler. At skjule dem er en app-læserindstilling.

Relateret