Skip to main content
POST
/
v1
/
admin
/
workspaces
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/admin/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "ownerId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "botCount": 123,
  "billingVersion": "v1",
  "plan": "community",
  "blocked": true,
  "spendingLimit": 123,
  "about": "",
  "profilePicture": "",
  "contactEmail": "",
  "website": "",
  "socialAccounts": [],
  "isPublic": true,
  "handle": "<string>",
  "activeTrialId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-multiple-integrations
string

Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Body

application/json

Workspace metadata

​
name
string
required

Response

Success

​
id
string
required
​
name
string
required
​
ownerId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
botCount
number
required
​
billingVersion
enum<string>
required
Available options:
v1,
v2,
v3
​
plan
enum<string>
required
Available options:
community,
team,
enterprise,
plus
​
blocked
boolean
required
​
spendingLimit
number
required
​
activeTrialId
string | null
required
​
about
string
default:""
​
profilePicture
string
default:""
​
contactEmail
string
default:""
​
website
string
default:""
​
socialAccounts
string[]
​
isPublic
boolean
​
handle
string