Skip to main content

​
Workspaces

Workspaces are containers that organize resources within a business: workers, assistants, channels, identities, and more. Each workspace is isolated and can have its own API keys and members. A Business is an aggregation of multiple workspaces, allowing you to organize different projects, environments, or departments under a single business entity.

​
Create Workspace

POST /workspace

Creates a new workspace and associates it with the authenticated user.

​
Request Body

​
string
required
Workspace name
​
string
Workspace description

​
Response

​
message
string
Success message
​
data
object

​
Update Workspace

PATCH /workspace/:workspace_id

Updates an existing workspace’s properties.
​
:workspace_id
string
required
Workspace unique identifier

​
Request Body

​
string
Workspace name
​
string
Workspace description

​
Create API Key

POST /workspace/api-keys

Creates a new API key for a workspace with defined permissions.

​
Request Body

​
string
required
API key name/description
​
array
required
Array of permission strings (e.g., [“read”, “write”])
​
string
required
Workspace identifier

​
Response

​
message
string
Success message
​
data
object

​
Workspace Resources

A workspace contains:
  • Workers - Conversation handlers
  • Assistants - AI entities
  • Channels - Communication endpoints
  • Identities - Contact aggregations
  • Memory - Context storage
  • Stages - Journey tracking
  • Scheduled Tasks - Automation

​
Business and Workspaces

  • Business - Top-level entity that aggregates multiple workspaces
  • Workspace - Container for resources within a business
  • Use workspaces to organize different projects, environments (dev/staging/prod), or departments
  • All workspaces within a business share the same business-level settings and billing

​
Examples

​
Create Workspace

curl -X POST https://api.plati.ai/workspace \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Company",
    "description": "Main workspace for production"
  }'

​
Update Workspace

curl -X PATCH https://api.plati.ai/workspace/workspace123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Workspace Name",
    "description": "Updated description"
  }'

​
Create API Key

curl -X POST https://api.plati.ai/workspace/api-keys \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API Key",
    "permissions": ["read", "write"],
    "workspace_id": "workspace123"
  }'

​
Next Steps

Authentication

Learn about API keys

Workers

Create workers in workspace

Channels

Set up channels