Browse the docs
Documentation

API reference

Every endpoint and webhook event of the VoiceCap API, with its parameters and fields.

Every endpoint takes your API key as a bearer token and lives under the base URL below. The same reference is available as an OpenAPI 3.1 file for tools that read one.

https://voicecap.ai/api/v1

Endpoints

Get the key owner

GET /me

The person the key acts as and their organization. Use it to test a key and to label a connection.

Response

Fields of data:

FieldTypeRequired
userobjectyes
user.idstringyes
user.emailstring (email)yes
user.namestring or nullyes
user.imagestring or nullno
user.emailVerifiedbooleanyes
orgobject or nullyes
org.idstringyes
org.namestringyes
org.slugstringyes
org.domainstring or nullyes
roleone of owner, admin, member, viewer or nullyes
memberSincestringno

Errors: On every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/me"

List meetings

GET /meetings

Meetings the key owner can open, newest first by default. Paged by page number.

Parameters

NameInTypeRequiredDescription
pagequeryintegernoPage number, from 1. Defaults to 1.
limitqueryintegernoHow many to return, 1 to 100. Defaults to 20.
sortByqueryone of date, title, duration, completedAtnodate (when the meeting happened), title, duration, or completedAt (when it finished processing). Defaults to date.
sortOrderqueryone of asc, descnoasc or desc. Defaults to desc.
statusqueryone of all, completed, processing, failednoall, completed, processing or failed. Defaults to all.
dateFromquerystringnoOnly meetings on or after this day, as YYYY-MM-DD.
dateToquerystringnoOnly meetings on or before this day, as YYYY-MM-DD.
searchquerystringnoOnly meetings whose title or transcript mentions this text.
completedAfterquerystring (date-time)noOnly completed meetings that finished processing after this instant. ISO 8601 with a time zone.

Response

Fields of data:

FieldTypeRequired
meetingsarray of objectyes
meetings[].idstring (uuid)yes
meetings[].titlestringyes
meetings[].createdAtstringyes
meetings[].recordedAtstring or nullno
meetings[].updatedAtstringyes
meetings[].audioDurationSecondsnumber or nullyes
meetings[].statusone of uploading, pending, recording, processing, summarizing, completed, failedyes
meetings[].sharedWithOrgbooleanyes
meetings[].linkEnabledbooleanyes
meetings[].sharedWithPeoplebooleanyes
meetings[].sharedWithGroupsbooleanyes
meetings[].errorMessage"processing_failed" or nullyes
meetings[].summaryPreviewstring or nullyes
meetings[].actionItemsCountnumberyes
totalCountnumberyes
hasMorebooleanyes

Errors: 400, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/meetings?status=completed&sortBy=completedAt&limit=5"

Get a meeting

GET /meetings/{id}

One meeting with its summary, action items, key topics and transcript. A meeting the key owner cannot open answers 404. A transcript too long to include (a recording many hours long) comes back with omitted: true and no text: read it with Get a transcript section.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe meeting id.

Response

Fields of data:

FieldTypeRequired
idstring (uuid)yes
titlestringyes
createdAtstringyes
audioDurationSecondsnumber or nullyes
statusone of uploading, pending, recording, processing, summarizing, completed, failedyes
sharedWithOrgbooleanyes
linkEnabledbooleanyes
userIdstringyes
languagestringyes
errorMessage"processing_failed" or nullyes
updatedAtstringyes
canEditbooleanyes
canDeletebooleanyes
canDownloadbooleanyes
canSharebooleanyes
transcriptobject or nullyes
transcript.fullTextstring or nullyes
transcript.segmentsarray of object or nullyes
transcript.speakersobject or nullyes
transcript.omittedbooleanyes
summaryobject or nullyes
summary.summarystring or nullyes
summary.actionItemsarray of object or nullyes
summary.keyTopicsarray of string or array of object or nullyes
participantEmailModeone of none, internal, all or nullyes
filesarray of objectyes
files[].idstring (uuid)yes
files[].meetingIdstring (uuid)yes
files[].fileNamestringyes
files[].durationSecondsnumber or nullyes
files[].languagestringyes
files[].statusone of uploading, pending, processing, completed, failedyes
files[].speakersobject or nullyes
files[].errorMessage"processing_failed" or nullyes
files[].createdAtstringyes
files[].updatedAtstringyes
recordedAtstring or nullno
calendarEventIdstring (uuid) or nullno

Errors: 404, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/meetings/0f8c2a4e-7b1d-4c3e-9a5f-2d6b8e1c4a7f"

Get a transcript section

GET /meetings/{id}/transcript

The transcript in sections of up to 15 minutes, for reading a meeting of any length. Start with startSeconds 0 and pass nextStartSeconds back as startSeconds until it is null: every segment comes back exactly once. A very dense stretch can end a section early. A meeting without a transcript answers 404 no_transcript.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe meeting id.
startSecondsquerynumbernoWhere the section starts, in seconds from the beginning of the recording. Defaults to 0.

Response

Fields of data:

FieldTypeRequired
meetingIdstring (uuid)yes
durationSecondsnumber or nullyes
startSecondsnumberyes
endSecondsnumberyes
segmentsarray of objectyes
segments[].speakerstringyes
segments[].textstringyes
segments[].startnumberyes
segments[].endnumberyes
speakersobject or nullyes
nextStartSecondsnumber or nullyes

Errors: 400, 404, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/meetings/0f8c2a4e-7b1d-4c3e-9a5f-2d6b8e1c4a7f/transcript?startSeconds=0"

Export a meeting

GET /meetings/{id}/export

The meeting as a file: PDF, Word, plain text or subtitles. A successful answer is the file itself, not JSON. Errors use the usual error body; srt of a meeting with no transcript answers 404 no_transcript.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe meeting id.
formatqueryone of pdf, docx, txt, srtyespdf, docx, txt or srt.
sectionsquerystringnoComma-separated: summary, actionItems, keyTopics, transcript. Defaults to all of them. srt is always the transcript only.

Response

A successful answer is the file itself, in one of these types:

  • application/pdf
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/x-subrip; charset=utf-8
  • text/plain; charset=utf-8

Errors: 400, 404, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/meetings/0f8c2a4e-7b1d-4c3e-9a5f-2d6b8e1c4a7f/export?format=txt&sections=transcript"

GET /search

Searches what was said in meetings the key owner can open. The same search as in the app.

Parameters

NameInTypeRequiredDescription
qquerystringyesWhat to search for, up to 500 characters.
limitqueryintegernoHow many to return, 1 to 100. Defaults to 20.
offsetqueryintegernoHow many to skip, up to 118. Defaults to 0.

Response

Fields of data:

FieldTypeRequired
resultsarray of objectyes
results[].meetingIdstring (uuid)yes
results[].meetingTitlestringyes
results[].meetingDatestringyes
results[].durationSecondsnumber or nullyes
results[].statusone of uploading, pending, recording, processing, summarizing, completed, failedyes
results[].headlinestringyes
results[].sourceone of transcript, summary, decisionno
results[].startSecondsnumber or nullno
results[].urlstringno
totalnumberyes
querystringyes
hasMorebooleanno

Errors: 400, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/search?q=pricing&limit=10"

List decisions

GET /decisions

Decisions from meetings the key owner can open, newest first.

Parameters

NameInTypeRequiredDescription
limitqueryintegernoHow many to return, 1 to 100. Defaults to 25.
offsetqueryintegernoHow many to skip, up to 1000. Defaults to 0.
meetingIdquerystring (uuid)noOnly decisions from this meeting.
sincequerystring (date-time)noOnly decisions recorded after this instant. ISO 8601 with a time zone, such as 2026-10-01T09:00:00Z.
qquerystringnoOnly decisions whose statement or context contains this text, ignoring case.
groupIdquerystring (uuid)noOnly decisions from meetings filed to this group. The key owner must belong to the group, unless they can see every meeting; any other group answers 404.

Response

Fields of data:

FieldTypeRequired
decisionsarray of objectyes
decisions[].idstring (uuid)yes
decisions[].statementstringyes
decisions[].contextstring or nullyes
decisions[].decidedBystring or nullyes
decisions[].meetingIdstring (uuid)yes
decisions[].meetingTitlestringyes
decisions[].meetingDatestringyes
decisions[].createdAtstringyes
decisions[].urlstringyes
hasMorebooleanyes

Errors: 400, 404, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/decisions?since=2026-10-01T00:00:00Z&limit=25"

List action items

GET /action-items

Action items from meetings the key owner can open, from the meeting that finished processing most recently first. For older items, narrow with since or meetingId rather than paging far back. At most 200 items are read from any one meeting; Get a meeting returns its full list.

Parameters

NameInTypeRequiredDescription
limitqueryintegernoHow many to return, 1 to 100. Defaults to 25.
offsetqueryintegernoHow many to skip, up to 1000. Defaults to 0.
meetingIdquerystring (uuid)noOnly items from this meeting.
sincequerystring (date-time)noOnly items from meetings that finished processing after this instant. ISO 8601 with a time zone, such as 2026-10-01T09:00:00Z.
assignedToMequeryone of true, falsenotrue for only the items assigned to the key owner.
completedqueryone of true, falsenotrue for only done items, false for only open ones.

Response

Fields of data:

FieldTypeRequired
actionItemsarray of objectyes
actionItems[].idstring or nullyes
actionItems[].textstringyes
actionItems[].assigneestring or nullyes
actionItems[].completedbooleanyes
actionItems[].timestampnumber or nullyes
actionItems[].meetingIdstring (uuid)yes
actionItems[].meetingTitlestringyes
actionItems[].meetingDatestringyes
actionItems[].completedAtstringyes
actionItems[].urlstringyes
hasMorebooleanyes
truncatedbooleanyes

Errors: 400, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/action-items?assignedToMe=true&completed=false"

List groups

GET /groups

Groups the key owner can see. Without limit and offset, every group comes back and hasMore is left out. An admin sees every group, but filtering by one needs membership in it unless they can see every meeting: isMember says which groups they belong to.

Parameters

NameInTypeRequiredDescription
limitqueryintegernoHow many to return, 1 to 100. Without it, every result comes back.
offsetqueryintegernoHow many to skip. Defaults to 0.

Response

Fields of data:

FieldTypeRequired
groupsarray of objectyes
groups[].idstring (uuid)yes
groups[].namestringyes
groups[].descriptionstringno
groups[].memberIdsarray of stringyes
groups[].memberCountintegeryes
groups[].createdBystringno
groups[].canEditbooleanno
groups[].isMemberbooleanno
groups[].companyWidebooleanno
groups[].updatedAtstringno
hasMorebooleanno

Errors: 400, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/groups?limit=50"

Subscribe a webhook

POST /hooks

Sends an event to your HTTPS URL each time it happens. Before the subscription starts, VoiceCap sends a signed test request with a challenge your endpoint must answer with: reply with only {"challenge": "…"}, never the whole request. The response holds the signing secret, shown only here. Subscribing the same event, URL and filters again with the same key returns the existing subscription with a new secret. While it is active the old secret keeps working for 24 hours; a suspended one is checked again and switches to the new secret at once.

Only an API key can call this endpoint.

Request body

FieldTypeRequired
eventstringyes
targetUrlstringyes
filtersobjectno

Response

Fields of data:

FieldTypeRequired
idstringyes
eventstringyes
filtersobjectyes
secretstringyes
createdbooleanyes

Errors: 400, 409, 422, and on every endpoint 401, 403 and 429.

Example

curl -X POST -H "Authorization: Bearer $VOICECAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event":"meeting.completed","targetUrl":"https://example.com/voicecap","filters":{"scope":"mine"}}' \
  "https://voicecap.ai/api/v1/hooks"

List webhooks

GET /hooks

The subscriptions this key created. Only the host of each URL is shown, never the full URL.

Only an API key can call this endpoint.

Response

Fields of data:

FieldTypeRequired
hooksarray of objectyes
hooks[].idstringyes
hooks[].eventstringyes
hooks[].filtersobjectyes
hooks[].targetHoststringyes
hooks[].statusone of active, suspended, expired, revokedyes
hooks[].statusReasonstring or nullyes
hooks[].lastDeliveryAtstring or nullyes
hooks[].lastErrorCategorystring or nullyes
hooks[].createdAtstringyes

Errors: On every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/hooks"

Unsubscribe a webhook

DELETE /hooks/{id}

Stops a subscription this key created. Always answers deleted: true, including for an id that is already gone or belongs to someone else, so it is safe to repeat.

Only an API key can call this endpoint.

Parameters

NameInTypeRequiredDescription
idpathstringyesThe subscription id from Subscribe a webhook.

Response

Fields of data:

FieldTypeRequired
deletedtrueyes

Errors: On every endpoint 401, 403 and 429.

Example

curl -X DELETE -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/hooks/3d5e7f90-1a2b-4c3d-8e9f-0a1b2c3d4e5f"

Get recent events

GET /hooks/sample

Events exactly like the data of a delivery, up to 10 per call. Without since or cursor: the newest, newest first, to test a subscription. With either: oldest first from that point, for polling instead of subscribing. Pass nextCursor back as cursor on the next call, and call again at once while hasMore is true, so no event is missed.

Only an API key can call this endpoint.

Parameters

NameInTypeRequiredDescription
eventquerystringyesThe event name: meeting.completed, decision.recorded or action_item.created.
sincequerystring (date-time)noOnly events after this instant. ISO 8601 with a time zone, such as 2026-10-01T09:00:00Z.
cursorquerystringnoThe nextCursor from the previous call. Polling resumes exactly after it. Wins over since.
limitqueryintegernoHow many to return, 1 to 10. Defaults to 10.
filtersqueryobjectnoThe same filters a subscription takes, one query parameter each, such as scope=mine or assignedToMe=true.

Response

Fields of data:

FieldTypeRequired
itemsarray of objectyes
items[].idstringyes
nextCursorstring or nullyes
hasMorebooleanyes

Errors: 400, 422, and on every endpoint 401, 403 and 429.

Example

curl -H "Authorization: Bearer $VOICECAP_API_KEY" \
  "https://voicecap.ai/api/v1/hooks/sample?event=meeting.completed&limit=3"

Webhook events

Each delivery is a POST with the body { eventId, name, timestamp, data, cursor }. Subscribe with the event name and any of its filters.

Meeting completed

meeting.completed

A meeting finished processing: its summary, action items and decisions are ready. Sent once per meeting.

Filters

NameTypeDescription
scopeone of mine, all_visiblemine: meetings you recorded. all_visible: every meeting you can open. Without it, mine for an owner or an admin who can see every meeting, unless groupId is set; otherwise all_visible.
classificationone of internal, external, anyinternal: every attendee is from your organization. external: someone from outside attended. any: every meeting, including one whose attendees are unknown, which internal and external never match. Defaults to any.
groupIdstring (uuid)Only meetings filed to this group. You must belong to the group, unless you can see every meeting; any other group is refused.
participantEmailstring (email)Only meetings with this attendee or identified speaker.
participantDomainstringOnly meetings with an attendee from exactly this email domain, such as acme.com.

Fields of data:

FieldTypeRequired
meetingIdstring (uuid)yes
titlestringyes
recordedAtstringyes
completedAtstringyes
durationSecondsinteger or nullyes
languagestring or nullyes
classificationone of internal, external, unknownyes
participantsarray of objectyes
participants[].namestringyes
participants[].emailstring or nullyes
groupsarray of objectyes
groups[].idstringyes
groups[].namestringyes
urlstring (uri)yes
summaryExcerptstringyes
countsobjectyes
counts.actionItemsintegeryes
counts.decisionsintegeryes
idstring (uuid)yes
summarystringyes
keyTopicsarray of stringyes
actionItemsarray of objectyes
actionItems[].idstringno
actionItems[].textstringyes
actionItems[].assigneestring or nullyes
actionItems[].completedbooleanyes
decisionsarray of objectyes
decisions[].idstring (uuid)yes
decisions[].statementstringyes
decisions[].decidedBystring or nullyes

Decision recorded

decision.recorded

One event per decision in a meeting that just finished processing, sent once.

Filters

NameTypeDescription
scopeone of mine, all_visiblemine: meetings you recorded. all_visible: every meeting you can open. Without it, mine for an owner or an admin who can see every meeting, unless groupId is set; otherwise all_visible.
classificationone of internal, external, anyinternal: every attendee is from your organization. external: someone from outside attended. any: every meeting, including one whose attendees are unknown, which internal and external never match. Defaults to any.
groupIdstring (uuid)Only meetings filed to this group. You must belong to the group, unless you can see every meeting; any other group is refused.
participantEmailstring (email)Only meetings with this attendee or identified speaker.
participantDomainstringOnly meetings with an attendee from exactly this email domain, such as acme.com.

Fields of data:

FieldTypeRequired
idstring (uuid)yes
statementstringyes
contextstring or nullyes
decidedBystring or nullyes
urlstring (uri)yes
meetingobjectyes
meeting.idstring (uuid)yes
meeting.titlestringyes
meeting.recordedAtstringyes
meeting.completedAtstringyes
meeting.urlstring (uri)yes

Action item created

action_item.created

One event per action item in the summary of a meeting that just finished processing, sent once. Items added by hand later are not sent.

Filters

NameTypeDescription
scopeone of mine, all_visiblemine: meetings you recorded. all_visible: every meeting you can open. Without it, mine for an owner or an admin who can see every meeting, unless groupId is set; otherwise all_visible.
classificationone of internal, external, anyinternal: every attendee is from your organization. external: someone from outside attended. any: every meeting, including one whose attendees are unknown, which internal and external never match. Defaults to any.
groupIdstring (uuid)Only meetings filed to this group. You must belong to the group, unless you can see every meeting; any other group is refused.
participantEmailstring (email)Only meetings with this attendee or identified speaker.
participantDomainstringOnly meetings with an attendee from exactly this email domain, such as acme.com.
assignedToMebooleanaction_item.created only: true for only the items assigned to you.

Fields of data:

FieldTypeRequired
idstring (uuid)yes
textstringyes
assigneestring or nullyes
completedbooleanyes
timestampnumber or nullyes
urlstring (uri)yes
meetingobjectyes
meeting.idstring (uuid)yes
meeting.titlestringyes
meeting.recordedAtstringyes
meeting.completedAtstringyes
meeting.urlstring (uri)yes