Skip to main content
POST
Create a workspace

Authorizations

X-API-KEY
string
header
required

Headers

X-End-User-ID
string | null

Body

application/json
name
string
required

The name of the workspace.

description
string | null

A brief description of the workspace's purpose.

is_default
boolean | null
default:false

Indicates if this is the default workspace for the user.

workspace_metadata
Workspace Metadata · object | null

Metadata for the workspace.

Response

Successful Response

id
string<uuid>
required

The unique identifier for the workspace.

name
string
required

The name of the workspace.

created_at
string<date-time>
required

The timestamp when the workspace was created.

updated_at
string<date-time>
required

The timestamp when the workspace was last updated.

document_count
integer
required

The number of documents contained within the workspace.

description
string | null

A brief description of the workspace's purpose.

is_default
boolean | null
default:false

Indicates if this is the default workspace for the user.

workspace_metadata
Workspace Metadata · object | null

Metadata for the workspace.