Create a workspace

POST/v1/workspaces

Create a workspace.

Creates a workspace in organization. Without a slug, one is derived from the name: lower case, spaces as dashes, anything but letters, digits and dashes dropped (workspace if nothing is left). A signed-in user who creates a workspace becomes its admin. Returns 201 with the workspace.

Requires an organization owner or admin, or an organization-scoped va_ key with the admin role. Errors: 402 when the plan's workspace limit is reached; 409 when the slug is already used in the organization.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Request body application/json

the workspace's organization, name, and optional slug and description

namestringrequired
The workspace's display name.
organizationstringrequired
The slug of the organization to create the workspace in.
slugstring
The workspace's slug, unique within the organization. Omit to derive it from name (lower case, spaces as dashes, other punctuation removed).
descriptionstring
An optional description.

Responses

201application/json

Created

idstring<uuid>
The workspace's id (UUID), used as workspace_id elsewhere in the API.
organizationstring
The slug of the organization the workspace belongs to.
slugstring
The workspace's slug, unique within the organization, used in workspace URLs.
namestring
The workspace's display name.
descriptionstring
A description of the workspace; absent when none was given.
default_routing_config_slugstring
The routing config the dashboard selects by default for this workspace; absent when none is set.
created_atstring<date-time>
When the workspace was created (ISO 8601 date-time).
updated_atstring<date-time>
When the workspace was last changed (ISO 8601 date-time).

Request

curl -X POST "https://api.vectoraxis.ai/v1/workspaces" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "organization": "string"
}'

VectorAxis is built by GK Labs, a member of NVIDIA Inception.