API-yhteenveto
Käytä Speechdashia omassa sovelluksessasi ja luo API-avainten, jotka antavat sille oikeudet.
Speechdash API:n avulla voit luoda omassa sovelluksessasi dokumentteja ja tuottaa puhetta samoin ääniä kuin sovellus. Kaikki API:n kautta luodut asiat näkyvät myös kirjastossasi. Valmiit äänitiedostot ja videon transkriptiot, jotka luodaan sovelluksessa, näkyvät kirjaston dokumentteina (source on transcription, ja siinä on transcript_id). Transkriptien REST-resurssia /transcripts ei ole: käytä dokumenttien loppuja. API ei käynnistä transkriptiotöitä.
Perusosoite:
https://api.speechdash.com/v1Terveystarkistus (ei API-avainta): GET https://api.speechdash.com/health
Koneellisesti luettava sopimus julkaistaan osoitteessa https://api.speechdash.com/v1/openapi.json, jotta voit generoida asiakirjan kielelle.
Loppupisteet
| Metodi | Polku | Käyttö |
|---|---|---|
GET | /health | Palvelun terveys (ei /v1-alueella) |
GET | /v1/openapi.json | OpenAPI 3.1-dokumentti |
GET | /v1/me | Tilin, suunnitelman ja lompakon tiedot |
GET | /v1/documents | Luettelo kirjaston dokumenteista, mukaan lukien valmiit transkriptiot |
POST | /v1/documents | Luo tekstidokumentti (source=api) |
GET | /v1/documents/{document_id} | Luetaan dokumentti ja sen teksti |
PUT | /v1/documents/{document_id} | Päivitä otsikko, teksti, kieli, is_archived tai visibility |
DELETE | /v1/documents/{document_id} | Poista dokumentti |
POST | /v1/documents/{document_id}/translate | Uusi käännetty versio (samat pisteet kuin MP3-exportti) |
GET | /v1/documents/{document_id}/export | Lataa pdf, docx, txt, csv, srt tai vtt |
POST | /v1/audio/speech | Synteettinen puhe jopa 5000 merkistä (JSON + ääni) |
POST | /v1/audio/stream | Virta WAV:ta, jopa 20 000 merkkiä |
POST | /v1/audio/stream/with-timestamps | SSE per-lauseen ääni ja merkinnät |
GET | /v1/voices | Äänikatalogi |
GET | /v1/voices/{voice_id} | Yksi äänen asetukset |
Interaktiiviset OpenAPI-sivut: Tili, Dokumentit, Ääni, Äänet.
MCP-palvelin (AI-apujen käyttöön)
Jos käytät Cursoria, Claude Desktopia tai muuta MCP-asiakasta, voit lisätä virallisen Speechdash MCP-palvelimen sen sijaan, että kutsut HTTP:tä itse. Se tarjoaa saman kirjaston (mukaan lukien valmiit transkriptiot), käännöksen, exportin, äänet, tilin kuvan ja ei-virtauksen puhe-synteesin työkaluina, jotka toimivat samojen API-avainten ja laskutuksen perusteella kuin tässä opastuksessa. Virtauspuhe jää REST:iin.
Katso MCP-palvelin koko työkaluluettelon ja asetuksen (stdio tai Streamable HTTP). Voit myös lukea Agents-hubia markkinointisivustolla, joka sisältää koneellisesti luettavia asiakirjoja, jotka ovat tarkoitettu AI-järjestelmille. Loppukäyttäjät voivat aloittaa API-avainten ja MCP:n asetuksista tässä Help Centerissä.
Luo API-avain
Avaa Asetukset → API.
Napsauta Uusi avain ja anna sille nimi, joka kertoo, missä sitä käytetään, kuten Tuotanto-palvelin.
Kopioi avain heti. Vain sen etumerkki tallennetaan, joten se näkyy vain kerran ja koskaan enää.
Avain vaikuttaa tilillesi. Pidä se palvelimellasi, ei koskaan selaimessa, mobiilisovelluksessa tai julkisessa repositoriossa. Jos avain vuotaa, peruuta se Asetukset → API ja luo uusi.
Voit pitää enintään 10 aktiivista avainta, nimetä ne uudelleen milloin tahansa ja nähdä, milloin kukin niistä käytettiin viimeksi. Avainin peruuttaminen pysäyttää sen pyynnöt välittömästi.
Tietokoneen tunnistaminen
Lähetä avain kantajana:
curl https://api.speechdash.com/v1/me \
-H "Authorization: Bearer sh_live_avainesi"Pyynnöt ilman voimassa olevaa avainta vastaavat 401 koodilla unauthorized.
GET /me palauttaa tilin tunnisteen, sähköpostin, suunnitelman ja lompakon saldo (wallet_cents ja display_credits), sekä lisätietoja käytetystä API-avainesta. Käytä sitä avainin varmistamiseen asetuksen jälkeen (esimerkiksi Zapierissä).
POST /documents ja POST /audio/speech hyväksyvät vapaaehtoisesti Idempotency-Key-päätteen. Toistamalla samaa avainta samalla ruumiilla toistetaan ensimmäinen onnistunut vastaus 24 tunniksi, jotta verkkohäiriö ei luo toista dokumenttia tai laskuta puhetta kahdesti. Jos puhevastaus on liian suuri tallentamiseksi, toistopyyntö samalla avainella vastaa 409 sen sijaan, että regeneroidaan (alkuperäinen pyyntö oli jo laskettu). POST /audio/speech -yhteyden katkeaminen vastaa 204, laskuttaa jo tuotetun äänin ja vapauttaa avainin, jotta toisto voi regeneroida. Virtausääni-loppupisteet hylkäävät päätteen.
Pisteet
Puhe-synteesi kuluttaa pisteitä samasta lompakosta kuin sovellus: 0.5 pistettä (1 lompakon sentti) jokaisesta 30 sekunnin aloituksesta tuotetusta äänestä. Jokainen pyyntö pitää arvioinnin (plus pieni marginaali) ennen synteesin aloittamista, sitten lasketaan äänen, joka todella tuotettiin. Käyttämättä jääneet varaukset palautetaan; jokainen laskettu pyyntö näkyy Asetukset → Pisteiden käyttö -kohtana API-puhe-synteesi. billed_credits -kenttä API-vastauksissa on lompakon senttejä (2 senttiä = 1 näkyvä piste). Jos virtaus keskeytyy keskellä, jo toimitetut lauseet laskutetaan edelleen.
Jos saldo ei riitä varaukseen, API vastaa 402 koodilla payment_required ennen kuin se tuottaa mitään.
Dokumenttien luominen ei kuluta pisteitä, mutta se lasketaan suunnitelman päivittäiseen dokumenttirajaan (Ilmainen: 3 päivässä; Unlimited: ei päivittäistä rajaa) ja tiedoston latausaikaan. Tiedoston exportti ei kuluta pisteitä.
Laskutus vs. sovelluksessa oleva Cloud-toisto
Sovelluksessa oleva Cloud-toisto käyttää dokumenttikohtaisen lauseen varastoa: toistamalla lause, joka on jo tuotettu palvelimella, voi maksaa 0 näkyvää pistettä. REST- ja MCP-puhe-loppupisteet synteettisivät aina uutta ääntä ja laskuttaisivat 30 sekunnin aloitusjakson samalla tavalla, kun synteesi tapahtuu. API:lla tai MCP:llä ei ole toistovarastoa.
Rajat
| Rajoitus | Arvo |
|---|---|
Pyynnöt /documents | 120 minuutissa, tilille |
Pyynnöt /audio/* | 60 minuutissa, tilille |
| Samanaikaiset puhepyynnöt | 3 tilille |
POST /audio/speech input | 5000 merkkiä |
POST /audio/stream input | 20 000 merkkiä |
| Dokumenttiteksti | 500 000 merkkiä |
| Aktiiviset API-avainet | 10 |
Rajat lasketaan tilille, ei avainelle, joten lisäavainet eivät nosta rajoja. Jokainen vastaus sisältää X-Request-ID, ja /documents sekä /audio/* palauttavat myös X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. Lähde X-Request-ID, kun otat yhteyttä tukipalveluun.
Puhepyynnöt myös rajoittavat samanaikista toimintaa: neljäs samanaikainen pyyntö vastaa 429, kun kolme on vielä käynnissä, jotta yksi integrointi ei voi monopolisoida synteesiä. Toista 429 ja 503 Retry-After-päätteen jälkeen.
Pitkille sisällöille, jotka ylittävät puhe-rajoitukset, luo dokumentti POST /v1/documents ja exporttaa sen ääni sovelluksesta.
Dokumentit: jaa, käännä, exportoi
Seriaalisoidut dokumentit sisältävät visibility ja share_url (null, kun se on yksityinen). PUT /v1/documents/{id} hyväksyy visibility julkaistaa luettelon näkymättömäksi lukukelpoiselle sivulle /share/document/{id}, ja is_archived arkistoida tai palauttaa. Jakamissivut ovat tekstinä. Ne eivät toista laskutettua ääntä.
POST /v1/documents/{id}/translate luo uuden käännetyn version. Se laskuttaa saman pistevaraston kuin MP3-exportti (0.5 pistettä aloituksesta 30 sekunnin arvioidusta puheesta) ja vastaa 402, kun varasto on lyhyt. Se vastaa 503, kun käännös ei ole asetettu tai poistettu käytöstä.
GET /v1/documents/{id}/export?format=pdf|docx|txt|csv|srt|vtt lataa nykyisen version liitteenä. Lisää timestamps=1 sisältämään osioiden aikamerkkejä PDF-, DOCX-, TXT- ja CSV-tiedostoissa. SRT ja VTT tarvitsevat transkription tai täydelliset lauseen aikamerkit. Tallennettu text GET /v1/documents/{id} säilyttää transkription aikamerkkien otsakkeet. Piilottaminen on vain lukijan asetusta.