Naršyti dokumentaciją
Dokumentacija

Apžvalga

Ką daro VoiceCap API, koks jo bazinis adresas ir kaip atrodo kiekvienas atsakymas.

VoiceCap API leidžia jūsų kodui ir automatizavimo įrankiams, pavyzdžiui, Zapier, Make ar n8n, skaityti jūsų susitikimus, sprendimus ir užduotis bei gauti webhook pranešimą, kai susitikimas paruoštas. API grąžina tuos pačius susitikimus, kuriuos matote VoiceCap, atrinktus pagal tas pačias taisykles: jūsų rolę, jūsų grupes ir su jumis bendrintus susitikimus.

Bazinis adresas

https://voicecap.ai/api/v1

Kiekviena užklausa Authorization antraštėje siunčia asmeninį API raktą. Kaip jį gauti, rasite puslapyje Autentifikacija.

Ką galima daryti

Galinis taškasKą daro
GET /meŽmogus ir organizacija, kuriems priklauso raktas. Tinka raktui patikrinti.
GET /meetingsSusitikimai, kuriuos galite atidaryti, su rikiavimu ir filtrais.
GET /meetings/{id}Vienas susitikimas su santrauka, užduotimis ir transkripcija.
GET /meetings/{id}/transcriptTranskripcija 15 minučių dalimis, bet kokio ilgio susitikimui.
GET /meetings/{id}/exportSusitikimas kaip PDF, Word, tekstinis ar subtitrų failas.
GET /searchPaieška tame, kas buvo pasakyta jūsų susitikimuose.
GET /decisionsSprendimai, naujausi pirmi.
GET /action-itemsUžduotys, pirmiausia iš vėliausiai apdoroto susitikimo.
GET /groupsGrupės, kurias matote.
POST /hooks, GET /hooks, DELETE /hooks/{id}Webhook užsakymas, sąrašas ir atsisakymas.
GET /hooks/sampleNaujausi įvykiai tokiu pačiu pavidalu, kokiu juos pristato webhook.

API nekuria, nekeičia, nebendrina ir netrina susitikimų. Vienintelis dalykas, kurį jis įrašo, yra webhook prenumeratos. Visi parametrai ir laukai išvardyti API žinyne, kuris taip pat pateikiamas kaip OpenAPI 3.1 failas.

Atsakymai

Kiekvienas JSON atsakymas yra apvalkalas. Sėkmingas atsakymas turi data:

{ "success": true, "data": { "decisions": [], "hasMore": false } }

Nesėkmingas turi error su code, kurį jūsų kodas gali patikrinti:

{ "success": false, "error": { "type": "error", "code": "invalid_api_key", "message": "Invalid API key" } }

Vienintelė išimtis yra eksportas: kai jis pavyksta, atsakymas yra pats failas.

Datos ir laikas

Kiekviena data yra ISO 8601 laiko momentas. Sąrašų galiniai taškai jas grąžina UTC laiku, pvz., 2026-10-16T08:30:00.000Z. Webhook įvykiuose nurodomas rakto savininko laiko zonos poslinkis, pvz., 2026-10-16T11:30:00+03:00. Abu žymi tą patį momentą, todėl lyginkite juos kaip laiką, o ne kaip tekstą.

Susiję puslapiai