Skip to main content
POST
/
workspaces
/
availability
Check workspace availability
curl --request POST \
  --url https://api.blaxel.ai/v0/workspaces/availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
true

Authorizations

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Query Parameters

​
withReason
boolean

When true, return a structured WorkspaceAvailability object with a machine-readable reason and human-readable message instead of a bare boolean. Defaults to false for backwards compatibility.

Body

application/json
​
name
string
required

Response

200 - application/json

successful operation

Last modified on May 28, 2026