Skip to main content
POST
Create a workspace

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Body

application/json
name
string
required

Name of the workspace.

Maximum string length: 100
metadata

Merged into the object's metadata: the keys you send are added or overwritten and the others kept. "" as a value removes that key; metadata: "" removes every key. Numbers and booleans are stored as their text; objects, arrays and null are refused.

Example:

Response

The created workspace.

id
string

Workspace ID, beginning with wks_. Treat it as an opaque string.

name
string

The workspace name, shown to its members in MeetingKit.

role
enum<string>

The authenticated user's role in this workspace.

  • owner: owns the workspace.
  • admin: manages the workspace.
  • member: records and reads their own meetings.
  • guest: sees only what is shared with them.
Available options:
owner,
admin,
member,
guest
created_at
string<date-time>

When it was created, in ISO 8601.

updated_at
string<date-time>

When it last changed, in ISO 8601.

owner_email
string

(staff only) Email address of the workspace owner.

members_count
integer

(staff only) Number of members, excluding guests and deleted users.

is_human_transcription_allowed
boolean

(staff only) Whether the workspace may order human transcription.

is_human_translation_allowed
boolean

(staff only) Whether the workspace may order human translation.

email_domains
string[]

(staff only) Domains that auto-join the workspace at sign-up.

idp_company_names
string[]

(staff only) IdP company names configured for SSO.

currency
string

(staff only) Billing currency code, e.g. usd, eur, gbp.

metadata
object

(staff only) Your key-value pairs.

Example:
settings
object

(staff only) What applies to the workspace's meetings that no member, category or meeting decides. On List workspaces, only with include=settings.

Example: