Skip to navigation
DocumentationReferenceAPI ReferenceEntity Store

Create a new workspace

View as Markdown

Create a new workspace.

The creator is automatically granted Admin role on the workspace. By default, this endpoint waits for the Admin role to propagate before returning. Use wait_role_propagation=false to skip waiting (useful for bulk operations).

Names beginning with sample- are reserved for the Agents sample flow.

Example:

POST /apis/entities/v2/workspaces
{
    "name": "ml-team",
    "description": "Machine Learning Team workspace"
}

Query parameters

wait_role_propagationbooleanOptionalDefaults to true

If true, wait for Admin role to propagate before returning (default: true). Set to false for bulk operations.

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"

Workspace name (unique identifier). Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).

descriptionstringOptional
Optional description of the workspace

Response

Successful Response
idstring

System-generated UUID

namestring

Workspace name (user-provided)

created_atdatetime
Timestamp of workspace creation
updated_atdatetime
Timestamp of last workspace update
descriptionstringOptional
Optional description
created_bystringOptional
Principal id for workspace creator
updated_bystringOptional
Principal id for last workspace update

Errors

422
Unprocessable Entity Error