Create Workspace
Developing
Develop Env
http://localhost:3000/api
Develop Env
http://localhost:3000/api
POST
http://localhost:3000/api
workspace
Maintainer:Suhaib Ghattass
Purpose
Create a new collaboration workspace within an existing organization. Used during team onboarding, course setup, or project initialization (e.g., “Product Launch Q4”, “Biology 201 Lab Group”).
Auth / Scope
User must be a member of the target organization with the workspace:create permission.
Typically granted to roles like admin, owner, or custom roles with explicit workspace management rights.
Regular members cannot create workspaces unless explicitly permitted via RBAC/ABAC policy.
Headers
Content-Type: application/jsonAuthorization: Bearer <JWT_OR_TOKEN>Idempotency-Key: <uuid>(if applicable)X-Request-ID: <uuid>(recommended for tracing)Accept-Language: <language-code>(if multilingual support applies)
Idempotency & retries
<Explain if idempotency is supported. Example: “Use Idempotency-Key to safely retry. Same key returns same result or 409 on conflict.”>
Rate limits
<Describe limits and behavior. Example: “20 requests/minute per user. Returns 429 with Retry-After header if exceeded.”>
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:3000/api/workspaces' \
--header 'Content-Type: application/json' \
--data-raw '{
"orgId": "a1b2c3d4-5678-90ef-1234-567890abcdef",
"name": "CS101: Introduction to AI",
"description": "Fall 2025 lecture series for undergraduate students",
"visibility": "org",
"settings": {
"timezone": "America/Los_Angeles",
"defaultLanguage": "en-US",
"educationMode": true,
"lmsIntegration": "canvas",
"examGenerationEnabled": true,
"beginnerModeDefault": true
},
"allowedDomains": [
"university.edu"
],
"featureFlags": {
"realTimeTranslation": true,
"roleAwareSummaries": true,
"examGeneration": true,
"breakoutRooms": true,
"aiAttendee": false
},
"supportedLanguages": [
"en-US",
"es-ES",
"fr-FR"
]
}'Response Response Example
200 - Example 1
{
"message": "Workspace created successfully",
"data": {
"workspaceId": "w-7d8e9f0a-1b2c-3d4e-5f6g-7h8i9j0k1l2m",
"orgId": "a1b2c3d4-5678-90ef-1234-567890abcdef",
"name": "CS101: Introduction to AI",
"description": "Fall 2025 lecture series for undergraduate students",
"visibility": "org",
"createdBy": "u-9f8e7d6c-5b4a-3210-fedc-ba9876543210",
"createdAt": "2025-10-22T15:45:30Z",
"updatedAt": "2025-10-22T15:45:30Z",
"settings": {
"timezone": "America/Los_Angeles",
"defaultLanguage": "en-US",
"educationMode": true,
"lmsIntegration": "canvas",
"examGenerationEnabled": true,
"beginnerModeDefault": true,
"dlpEnabled": true,
"realTimeSummaries": true,
"retentionAlerts": true
},
"allowedDomains": [
"university.edu"
],
"featureFlags": {
"realTimeTranslation": true,
"roleAwareSummaries": true,
"examGeneration": true,
"breakoutRooms": true,
"aiAttendee": false,
"meetingEnergyDashboard": false
},
"supportedLanguages": [
"en-US",
"es-ES",
"fr-FR"
],
"subscriptionId": "sub-abc123def456",
"memberCount": 1
}
}Modified at 2025-10-22 21:42:58