
Base URLs:
https://api-us.sembly.ai: US region
https://api-eu.sembly.ai: EU region
GET /v1/workspace/users
All users of the workspace, including deactivated accounts, newest first.
Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| query | string or null | no | Case-insensitive substring of the email. |
| query | string or null | no | Return only this user id. |
| query | integer | no | Rows to skip. (min 0, max 1000000, default 0) |
| query | integer | no | Page size. (min 1, max 200, default 50) |
Status | Body | Description |
|---|---|---|
200 |
| Successful Response |
400 |
| A parameter is invalid. Code |
401 |
| Token is missing or not usable: |
403 |
| The workspace or client may not use the API: |
429 |
| Rate limit exceeded. Code |
500 |
| Unexpected server error. Code |
GET /v1/workspace/meetings
Meetings of the workspace, ordered by started_at (newest first), then by id. Private meetings are included. Archived, welcome, scheduled, not scheduled and duplicate meetings and meetings without a recording are not listed. Poll with processed_after to find newly processed meetings: read every page, then move your checkpoint to the largest processed_at you saw.
Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| query | list of string | no | Repeat to combine. Allowed: |
| query | string or null | no | Owner user id. |
| query | list of string | no | User ids, repeat to combine, at most 10. Only meetings accessible to all of them. A filter, not an authorization check: your app decides what each of its users may see. |
| query | string or null | no | ISO 8601. Inclusive. Without a timezone, UTC is assumed. Example: |
| query | string or null | no | ISO 8601. Inclusive. Without a timezone, UTC is assumed. Example: |
| query | string or null | no | ISO 8601. Only meetings processed strictly after this moment. Without a timezone, UTC is assumed. Example: |
| query | string or null | no | Case-insensitive substring of the title. |
| query | integer | no | Rows to skip. (min 0, max 1000000, default 0) |
| query | integer | no | Page size. (min 1, max 200, default 50) |
Status | Body | Description |
|---|---|---|
200 |
| Successful Response |
400 |
| A parameter is invalid. Code |
401 |
| Token is missing or not usable: |
403 |
| The workspace or client may not use the API: |
429 |
| Rate limit exceeded. Code |
500 |
| Unexpected server error. Code |
GET /v1/workspace/meetings/{meeting_uuid}
Meeting details. Add notes, tasks and transcript to include them. Content is returned only for processed meetings. A meeting the list leaves out returns 404 meeting_not_found.
Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| path | uuid | yes | Meeting |
| query | integer | no | 1 to include the transcript. (min 0, max 1, default 0) |
| query | integer | no | 1 to include the notes. (min 0, max 1, default 0) |
| query | integer | no | 1 to include the tasks. (min 0, max 1, default 0) |
Status | Body | Description |
|---|---|---|
200 |
| Successful Response |
400 |
| A parameter is invalid. Code |
401 |
| Token is missing or not usable: |
403 |
| The workspace or client may not use the API: |
404 |
| The meeting does not exist in this workspace. Code |
429 |
| Rate limit exceeded. Code |
500 |
| Unexpected server error. Code |
GET /v1/workspace/meetings/{meeting_uuid}/transcript
Transcript items in spoken order. Follow next_cursor until it is null. The list is empty until the meeting is processed.
Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| path | uuid | yes | Meeting |
| query | string or null | no |
|
| query | integer | no | Page size. (min 1, max 2000, default 500) |
Status | Body | Description |
|---|---|---|
200 |
| Successful Response |
400 |
| A parameter is invalid. Codes |
401 |
| Token is missing or not usable: |
403 |
| The workspace or client may not use the API: |
404 |
| The meeting does not exist in this workspace. Code |
429 |
| Rate limit exceeded. Code |
500 |
| Unexpected server error. Code |
Field | Type | Required | Description |
|---|---|---|---|
| list of | yes | Users, newest account first. |
|
| yes | Offset pagination of this list. |
The body of every non-2xx response.
Field | Type | Required | Description |
|---|---|---|---|
|
| yes | What went wrong. Branch on |
Field | Type | Required | Description |
|---|---|---|---|
| list of | yes | Meetings, newest |
|
| yes | Offset pagination of this list. |
Field | Type | Required | Description |
|---|---|---|---|
| uuid | yes | Meeting id. Use it to fetch content. It does not change once the meeting is recorded. A |
| string | yes | Opens the meeting in the Sembly web app. The person opening it signs in and needs access to the meeting. |
| string or null | yes | Meeting title. Null when the meeting has none. |
| datetime or null | yes | When the meeting started, UTC. |
| datetime or null | yes | When the meeting ended, UTC. Null while it is running or when unknown. |
| integer | yes | Recorded duration in seconds. 0 when unknown. |
| string or null | yes | Meeting type, lowercase, for example |
|
| yes | Where the meeting took place or where the recording came from. New values may be added; treat unknown ones as |
|
| yes |
|
| datetime or null | yes | When processing finished. Null until |
|
| yes | Workspace user who owns the meeting. Null when the owner left the workspace. |
| list of | yes | Workspace users who have access to the meeting. |
|
| yes | Calendar event the meeting was scheduled from. Null for uploads, recordings and meetings added without a calendar event. |
|
| no | Present only with |
| list of | no | Present only with |
| list of | no | Present only with |
Field | Type | Required | Description |
|---|---|---|---|
|
| yes | Processing state of the meeting. |
| list of | yes | Empty until the meeting is processed. |
| string or null | yes | Pass as |
Field | Type | Required | Description |
|---|---|---|---|
| uuid | yes | User id. Use it in |
| string | yes | Email of the user, unique in the workspace. |
| string | yes | Display name. Empty when the user has not set one. |
| datetime | yes | When the account was created, UTC. |
| boolean | yes | False for deactivated accounts, which are still listed. |
Field | Type | Required | Description |
|---|---|---|---|
| integer | yes | Offset of the first returned row. |
| integer | yes | Requested page size. |
| boolean | yes | True when another page follows. Increase |
Field | Type | Required | Description |
|---|---|---|---|
|
| yes | Stable machine-readable error code. |
| string | yes | Human-readable explanation. Do not parse it. |
Field | Type | Required | Description |
|---|---|---|---|
| uuid | yes | Meeting id. Use it to fetch content. It does not change once the meeting is recorded. A |
| string | yes | Opens the meeting in the Sembly web app. The person opening it signs in and needs access to the meeting. |
| string or null | yes | Meeting title. Null when the meeting has none. |
| datetime or null | yes | When the meeting started, UTC. |
| datetime or null | yes | When the meeting ended, UTC. Null while it is running or when unknown. |
| integer | yes | Recorded duration in seconds. 0 when unknown. |
| string or null | yes | Meeting type, lowercase, for example |
|
| yes | Where the meeting took place or where the recording came from. New values may be added; treat unknown ones as |
|
| yes |
|
| datetime or null | yes | When processing finished. Null until |
|
| yes | Workspace user who owns the meeting. Null when the owner left the workspace. |
| list of | yes | Workspace users who have access to the meeting. |
|
| yes | Calendar event the meeting was scheduled from. Null for uploads, recordings and meetings added without a calendar event. |
Where the meeting took place or where the recording came from.
Values: zoom, ms_teams, google_meet, webex, upload, recording, other.
Public processing state of a meeting.
Values: processed, in_progress, failed.
Field | Type | Required | Description |
|---|---|---|---|
| uuid | yes | User id, as returned by |
| string | yes | Email of the user, unique in the workspace. |
The calendar event a meeting was scheduled from.
Field | Type | Required | Description |
|---|---|---|---|
|
| yes |
|
| string or null | yes | iCalendar UID of the event, the same in every attendee's calendar. Match on it. For an occurrence of a recurring |
| list of string | yes | Provider ids of this event in the calendars Sembly synced. A |
| list of string | yes | Provider ids of the recurring series, in the same calendars as |
| boolean | yes | True when the event is part of a recurring series. |
Field | Type | Required | Description |
|---|---|---|---|
| string | yes | Meeting type the notes were written for, lowercase. |
| string | yes | Meeting notes body, as HTML. |
Field | Type | Required | Description |
|---|---|---|---|
| string | yes | Short task title. |
| string | yes | Task text as captured from the meeting. |
| string | yes |
|
| string or null | yes | ISO 8601 due date, when the task has one. |
| string or null | yes | Timing phrase as spoken in the meeting. |
|
| yes | Who should do the task. |
|
| yes | Who gave the task. |
Field | Type | Required | Description |
|---|---|---|---|
| number | yes | Start offset in seconds. |
| number | yes | End offset in seconds. |
| string | yes | What was said. |
| boolean | yes | True when several people spoke at once. |
|
| yes | Who said it. |
Stable machine-readable codes. Clients should branch on these, not on messages.
Values: missing_token, invalid_token, disabled_token, expired_token, workspace_disabled, workspace_not_eligible, plan_not_allowed, api_disabled, ip_not_allowed, invalid_parameters, invalid_cursor, meeting_not_found, not_found, rate_limited, internal_error.
Where Sembly learned about the meeting's calendar event.
Values: microsoft, google, ics, email.
A person named on a task or utterance. user is set only when matched.
Field | Type | Required | Description |
|---|---|---|---|
| string | yes | Name as spoken or written in the meeting. |
|
| yes | Workspace user this name was matched to, if any. |
Field | Type | Required | Description |
|---|---|---|---|
| integer | yes | Speaker id, stable within the meeting. |
| string | yes | Speaker name or a generic label. |
|
| yes | Workspace user this speaker was matched to. Null when not matched. |