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:
| Field | Type | Required |
|---|---|---|
user | object | yes |
user.id | string | yes |
user.email | string (email) | yes |
user.name | string or null | yes |
user.image | string or null | no |
user.emailVerified | boolean | yes |
org | object or null | yes |
org.id | string | yes |
org.name | string | yes |
org.slug | string | yes |
org.domain | string or null | yes |
role | one of owner, admin, member, viewer or null | yes |
memberSince | string | no |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | no | Page number, from 1. Defaults to 1. |
limit | query | integer | no | How many to return, 1 to 100. Defaults to 20. |
sortBy | query | one of date, title, duration, completedAt | no | date (when the meeting happened), title, duration, or completedAt (when it finished processing). Defaults to date. |
sortOrder | query | one of asc, desc | no | asc or desc. Defaults to desc. |
status | query | one of all, completed, processing, failed | no | all, completed, processing or failed. Defaults to all. |
dateFrom | query | string | no | Only meetings on or after this day, as YYYY-MM-DD. |
dateTo | query | string | no | Only meetings on or before this day, as YYYY-MM-DD. |
search | query | string | no | Only meetings whose title or transcript mentions this text. |
completedAfter | query | string (date-time) | no | Only completed meetings that finished processing after this instant. ISO 8601 with a time zone. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
meetings | array of object | yes |
meetings[].id | string (uuid) | yes |
meetings[].title | string | yes |
meetings[].createdAt | string | yes |
meetings[].recordedAt | string or null | no |
meetings[].updatedAt | string | yes |
meetings[].audioDurationSeconds | number or null | yes |
meetings[].status | one of uploading, pending, recording, processing, summarizing, completed, failed | yes |
meetings[].sharedWithOrg | boolean | yes |
meetings[].linkEnabled | boolean | yes |
meetings[].sharedWithPeople | boolean | yes |
meetings[].sharedWithGroups | boolean | yes |
meetings[].errorMessage | "processing_failed" or null | yes |
meetings[].summaryPreview | string or null | yes |
meetings[].actionItemsCount | number | yes |
totalCount | number | yes |
hasMore | boolean | yes |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | The meeting id. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
id | string (uuid) | yes |
title | string | yes |
createdAt | string | yes |
audioDurationSeconds | number or null | yes |
status | one of uploading, pending, recording, processing, summarizing, completed, failed | yes |
sharedWithOrg | boolean | yes |
linkEnabled | boolean | yes |
userId | string | yes |
language | string | yes |
errorMessage | "processing_failed" or null | yes |
updatedAt | string | yes |
canEdit | boolean | yes |
canDelete | boolean | yes |
canDownload | boolean | yes |
canShare | boolean | yes |
transcript | object or null | yes |
transcript.fullText | string or null | yes |
transcript.segments | array of object or null | yes |
transcript.speakers | object or null | yes |
transcript.omitted | boolean | yes |
summary | object or null | yes |
summary.summary | string or null | yes |
summary.actionItems | array of object or null | yes |
summary.keyTopics | array of string or array of object or null | yes |
participantEmailMode | one of none, internal, all or null | yes |
files | array of object | yes |
files[].id | string (uuid) | yes |
files[].meetingId | string (uuid) | yes |
files[].fileName | string | yes |
files[].durationSeconds | number or null | yes |
files[].language | string | yes |
files[].status | one of uploading, pending, processing, completed, failed | yes |
files[].speakers | object or null | yes |
files[].errorMessage | "processing_failed" or null | yes |
files[].createdAt | string | yes |
files[].updatedAt | string | yes |
recordedAt | string or null | no |
calendarEventId | string (uuid) or null | no |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | The meeting id. |
startSeconds | query | number | no | Where the section starts, in seconds from the beginning of the recording. Defaults to 0. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
meetingId | string (uuid) | yes |
durationSeconds | number or null | yes |
startSeconds | number | yes |
endSeconds | number | yes |
segments | array of object | yes |
segments[].speaker | string | yes |
segments[].text | string | yes |
segments[].start | number | yes |
segments[].end | number | yes |
speakers | object or null | yes |
nextStartSeconds | number or null | yes |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | The meeting id. |
format | query | one of pdf, docx, txt, srt | yes | pdf, docx, txt or srt. |
sections | query | string | no | Comma-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/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/x-subrip; charset=utf-8text/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§ions=transcript"
Search meetings
GET /search
Searches what was said in meetings the key owner can open. The same search as in the app.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
q | query | string | yes | What to search for, up to 500 characters. |
limit | query | integer | no | How many to return, 1 to 100. Defaults to 20. |
offset | query | integer | no | How many to skip, up to 118. Defaults to 0. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
results | array of object | yes |
results[].meetingId | string (uuid) | yes |
results[].meetingTitle | string | yes |
results[].meetingDate | string | yes |
results[].durationSeconds | number or null | yes |
results[].status | one of uploading, pending, recording, processing, summarizing, completed, failed | yes |
results[].headline | string | yes |
results[].source | one of transcript, summary, decision | no |
results[].startSeconds | number or null | no |
results[].url | string | no |
total | number | yes |
query | string | yes |
hasMore | boolean | no |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | How many to return, 1 to 100. Defaults to 25. |
offset | query | integer | no | How many to skip, up to 1000. Defaults to 0. |
meetingId | query | string (uuid) | no | Only decisions from this meeting. |
since | query | string (date-time) | no | Only decisions recorded after this instant. ISO 8601 with a time zone, such as 2026-10-01T09:00:00Z. |
q | query | string | no | Only decisions whose statement or context contains this text, ignoring case. |
groupId | query | string (uuid) | no | Only 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:
| Field | Type | Required |
|---|---|---|
decisions | array of object | yes |
decisions[].id | string (uuid) | yes |
decisions[].statement | string | yes |
decisions[].context | string or null | yes |
decisions[].decidedBy | string or null | yes |
decisions[].meetingId | string (uuid) | yes |
decisions[].meetingTitle | string | yes |
decisions[].meetingDate | string | yes |
decisions[].createdAt | string | yes |
decisions[].url | string | yes |
hasMore | boolean | yes |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | How many to return, 1 to 100. Defaults to 25. |
offset | query | integer | no | How many to skip, up to 1000. Defaults to 0. |
meetingId | query | string (uuid) | no | Only items from this meeting. |
since | query | string (date-time) | no | Only items from meetings that finished processing after this instant. ISO 8601 with a time zone, such as 2026-10-01T09:00:00Z. |
assignedToMe | query | one of true, false | no | true for only the items assigned to the key owner. |
completed | query | one of true, false | no | true for only done items, false for only open ones. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
actionItems | array of object | yes |
actionItems[].id | string or null | yes |
actionItems[].text | string | yes |
actionItems[].assignee | string or null | yes |
actionItems[].completed | boolean | yes |
actionItems[].timestamp | number or null | yes |
actionItems[].meetingId | string (uuid) | yes |
actionItems[].meetingTitle | string | yes |
actionItems[].meetingDate | string | yes |
actionItems[].completedAt | string | yes |
actionItems[].url | string | yes |
hasMore | boolean | yes |
truncated | boolean | yes |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | How many to return, 1 to 100. Without it, every result comes back. |
offset | query | integer | no | How many to skip. Defaults to 0. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
groups | array of object | yes |
groups[].id | string (uuid) | yes |
groups[].name | string | yes |
groups[].description | string | no |
groups[].memberIds | array of string | yes |
groups[].memberCount | integer | yes |
groups[].createdBy | string | no |
groups[].canEdit | boolean | no |
groups[].isMember | boolean | no |
groups[].companyWide | boolean | no |
groups[].updatedAt | string | no |
hasMore | boolean | no |
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
| Field | Type | Required |
|---|---|---|
event | string | yes |
targetUrl | string | yes |
filters | object | no |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
id | string | yes |
event | string | yes |
filters | object | yes |
secret | string | yes |
created | boolean | yes |
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:
| Field | Type | Required |
|---|---|---|
hooks | array of object | yes |
hooks[].id | string | yes |
hooks[].event | string | yes |
hooks[].filters | object | yes |
hooks[].targetHost | string | yes |
hooks[].status | one of active, suspended, expired, revoked | yes |
hooks[].statusReason | string or null | yes |
hooks[].lastDeliveryAt | string or null | yes |
hooks[].lastErrorCategory | string or null | yes |
hooks[].createdAt | string | yes |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | The subscription id from Subscribe a webhook. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
deleted | true | yes |
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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
event | query | string | yes | The event name: meeting.completed, decision.recorded or action_item.created. |
since | query | string (date-time) | no | Only events after this instant. ISO 8601 with a time zone, such as 2026-10-01T09:00:00Z. |
cursor | query | string | no | The nextCursor from the previous call. Polling resumes exactly after it. Wins over since. |
limit | query | integer | no | How many to return, 1 to 10. Defaults to 10. |
filters | query | object | no | The same filters a subscription takes, one query parameter each, such as scope=mine or assignedToMe=true. |
Response
Fields of data:
| Field | Type | Required |
|---|---|---|
items | array of object | yes |
items[].id | string | yes |
nextCursor | string or null | yes |
hasMore | boolean | yes |
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
| Name | Type | Description |
|---|---|---|
scope | one of mine, all_visible | mine: 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. |
classification | one of internal, external, any | internal: 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. |
groupId | string (uuid) | Only meetings filed to this group. You must belong to the group, unless you can see every meeting; any other group is refused. |
participantEmail | string (email) | Only meetings with this attendee or identified speaker. |
participantDomain | string | Only meetings with an attendee from exactly this email domain, such as acme.com. |
Fields of data:
| Field | Type | Required |
|---|---|---|
meetingId | string (uuid) | yes |
title | string | yes |
recordedAt | string | yes |
completedAt | string | yes |
durationSeconds | integer or null | yes |
language | string or null | yes |
classification | one of internal, external, unknown | yes |
participants | array of object | yes |
participants[].name | string | yes |
participants[].email | string or null | yes |
groups | array of object | yes |
groups[].id | string | yes |
groups[].name | string | yes |
url | string (uri) | yes |
summaryExcerpt | string | yes |
counts | object | yes |
counts.actionItems | integer | yes |
counts.decisions | integer | yes |
id | string (uuid) | yes |
summary | string | yes |
keyTopics | array of string | yes |
actionItems | array of object | yes |
actionItems[].id | string | no |
actionItems[].text | string | yes |
actionItems[].assignee | string or null | yes |
actionItems[].completed | boolean | yes |
decisions | array of object | yes |
decisions[].id | string (uuid) | yes |
decisions[].statement | string | yes |
decisions[].decidedBy | string or null | yes |
Decision recorded
decision.recorded
One event per decision in a meeting that just finished processing, sent once.
Filters
| Name | Type | Description |
|---|---|---|
scope | one of mine, all_visible | mine: 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. |
classification | one of internal, external, any | internal: 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. |
groupId | string (uuid) | Only meetings filed to this group. You must belong to the group, unless you can see every meeting; any other group is refused. |
participantEmail | string (email) | Only meetings with this attendee or identified speaker. |
participantDomain | string | Only meetings with an attendee from exactly this email domain, such as acme.com. |
Fields of data:
| Field | Type | Required |
|---|---|---|
id | string (uuid) | yes |
statement | string | yes |
context | string or null | yes |
decidedBy | string or null | yes |
url | string (uri) | yes |
meeting | object | yes |
meeting.id | string (uuid) | yes |
meeting.title | string | yes |
meeting.recordedAt | string | yes |
meeting.completedAt | string | yes |
meeting.url | string (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
| Name | Type | Description |
|---|---|---|
scope | one of mine, all_visible | mine: 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. |
classification | one of internal, external, any | internal: 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. |
groupId | string (uuid) | Only meetings filed to this group. You must belong to the group, unless you can see every meeting; any other group is refused. |
participantEmail | string (email) | Only meetings with this attendee or identified speaker. |
participantDomain | string | Only meetings with an attendee from exactly this email domain, such as acme.com. |
assignedToMe | boolean | action_item.created only: true for only the items assigned to you. |
Fields of data:
| Field | Type | Required |
|---|---|---|
id | string (uuid) | yes |
text | string | yes |
assignee | string or null | yes |
completed | boolean | yes |
timestamp | number or null | yes |
url | string (uri) | yes |
meeting | object | yes |
meeting.id | string (uuid) | yes |
meeting.title | string | yes |
meeting.recordedAt | string | yes |
meeting.completedAt | string | yes |
meeting.url | string (uri) | yes |