API-oversikt

Speechdash API lar din egen applikasjon lage dokumenter og generere tale med de samme stemmene som appen. Alt du lager via API vises også i din bibliotek. Ferdige lyd- og videotranskripsjoner som er laget i appen vises også som bibliotekdokumenter (source er transcription, med en transcript_id). Det finnes ikke en /transcripts REST-resurs: bruk dokumentendepunktene. APIet starter ikke transkripsjonsjobber.

Base URL:

https://api.speechdash.com/v1

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

Den maskinlesbare kontrakten er publisert på https://api.speechdash.com/v1/openapi.json, slik at du kan generere en klient for ditt språk.

Endepunkter

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

MCP-tjenere (for AI-assistenter)

Hvis du bruker Cursor, Claude Desktop, eller en annen MCP klient, kan du legge til den offisielle Speechdash MCP-tjeneren i stedet for å kalle HTTP selv. Den eksponerer samme bibliotek (inkludert ferdige transkripsjoner), oversettelse, eksport, stemmer, konto-snapshot og ikke-strømmende tale-syntese som verktøy som er støttet av de samme API-nøklene og fakturering som denne guiden. Strømmende tale forblir på REST.

Se MCP-tjenere for fullstendig verktøyliste og oppsett (stdio eller Streamable HTTP). Du kan også lese Agents hub på markedsiden for maskinlesbare dokumenter som er rettet mot AI-systemer. Sluttbrukere kan starte fra API-nøkler og MCP i denne Hjelpe-senteren.

Lag en API-nøkkel

Du kan holde opp til 10 aktive nøkler, omdøpe dem når som helst, og se når hver av dem ble brukt sist. Å avbryte en nøkkel stopper dens forespørsler umiddelbart.

Autentiser en forespørsel

Send nøkkelen som en bærertoken:

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

Forespørsler uten en gyldig nøkkel svarer med 401 og koden unauthorized.

GET /me returnerer din konto-id, e-post, plan og lommebok-balanse (wallet_cents og display_credits), samt metadata om den API-nøkkelen som ble brukt. Bruk dette til å verifisere en nøkkel etter oppsett (for eksempel i Zapier).

POST /documents og POST /audio/speech tar en valgfri Idempotency-Key hode. Å prøve på nytt med samme nøkkel og samme kropp gjentar den første vellykkede svaret i 24 timer, slik at en midlertidig nettverksfeil ikke lager et annet dokument eller fakturerer tale to ganger. Hvis et talerespons er for stor til å lagre, svarer en pånyttforsøk med samme nøkkel 409 i stedet for å generere på nytt (den opprinnelige forespørselen ble allerede fakturert). En klientavbrudd på /audio/speech svarer 204, regler av eventuell lyd som er blitt produsert, og frigjør nøkkelen slik at en pånyttforsøk kan generere på nytt. Strømmende lyd-endepunkter avviser hodet.

Kreditter

Tale-syntese bruker kreditter fra samme lommebok som appen: 0,5 kreditter (1 lommebok-cent) per startet 30 sekunder av generert lyd. Hver forespørsel har en estimat (pluss en liten margin) før genereringen starter, og så regnes det opp til den faktisk produserte lyden. Ubrukt hold refunderes; hver regnet forespørsel vises i Innstillinger → Kredittbruk som API tale-syntese. Feltet billed_credits i API-svarene er lommebok-cent (2 cent = 1 visningskreditt). Hvis en strøm blir avbrutt midtveis, blir setningene som allerede er levert likevel fakturert.

Hvis din saldo ikke kan dekke holdet, svarer APIet med 402 og koden payment_required før noe genereres.

Lagring av dokumenter bruker ikke kreditter, men det teller mot din plans daglige dokumentgrense (Gratis: 3 per dag; Unlimited: ingen daglig grense) og oppslukningsvarighet. Eksport av filer bruker ikke kreditter.

Fakturering vs. innbygd Cloud-avspilling

Innbygd Cloud avspilling gjenbruker per-dokument setningskache: å avspille en setning som allerede er generert på serveren kan koste 0 visningskreditter. REST og MCP tale-endepunkter syntetiserer alltid frisk lyd og fakturerer per startet 30 sekunder med samme rate når genereringen skjer. Det finnes ingen avspillingskache på API eller MCP syntese.

Grenser

Rate-limitter telles per konto, ikke per nøkkel, så ekstra nøkler øker ikke din kvote. Hvert svar inneholder X-Request-ID, og /documents og /audio/* returnerer også X-RateLimit-Limit, X-RateLimit-Remaining, og X-RateLimit-Reset. Sitater X-Request-ID når du kontakter support.

Tale-forespørsler har også en parallelisitet-grense: en fjerde samtidig forespørsel svarer med 429 mens tre fortsatt kjører, slik at en integrasjon ikke kan monopolisere syntesen. Prøv på nytt 429 og 503 etter Retry-After-hodet.

For innhold som er lengre enn tale-grensene, lag et dokument med POST /v1/documents og eksporter lyd fra appen.

Dokumenter: del, oversett, eksporter

Serialiserte dokumenter inkluderer visibility og share_url (null når privat). PUT /v1/documents/{id} tar imot visibility for å publisere en ulistet lesbar side på /share/document/{id}, og is_archived for å arkivere eller gjenopprette. Delte sider er tekst- bare. De avspiller ikke fakturerte lydfiler.

POST /v1/documents/{id}/translate lager en ny oversatt versjon. Den fakturerer samme lommebok som MP3-eksport (0,5 kreditter per startet 30 sekunder av estimert tale) og svarer 402 når lommeboken er tom. Den svarer 503 når oversettelse ikke er konfigurert eller er ned.

GET /v1/documents/{id}/export?format=pdf|docx|txt|csv|srt|vtt last ned den nåværende versjonen som vedlegg. Legg til timestamps=1 for å inkludere avsnittstider på PDF, DOCX, TXT og CSV. SRT og VTT trenger en transkripsjon eller fullstendige setnings-tider. Lagret text på GET /v1/documents/{id} beholder transkripsjonstidsstempler. Å skjule dem er en leserinnstilling i appen.

Relaterte