ReferenceWorkspaces

Create a workspace

Creates a workspace and provisions its primary shared memory.

Subject to the workspaces resource limit on your plan. Exceeding it returns 402 with an upgrade prompt — buying credits does not raise a tier limit.

POST
/api/v1/workspaces

Authorization

ApiKeyAuth
x-api-key<token>

A platform key (ck_live_…). Mint one in the console under Settings → API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/workspaces" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "workspace": {    "workspace_id": "string",    "tenant_id": "string",    "name": "string",    "description": "string",    "slug": "string",    "is_default": true,    "primary_memory_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}
Was this page helpful?
Report an issue