Skip to content
Olivares AI docs

Create a workspace (tenant admin, AAL3 step-up)

POST
/v1/workspaces
 
curl --request POST \
  --url https://example.com/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "settings": {}, "slug": "example" }'

Creates one workspace. Beyond the tenant admin permission the caller must be the tenant owner or a superadmin, because a workspace admin administers within a workspace and does not mint them.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
settings
object
key
additional properties
any
slug
required
string
/^[a-z0-9][a-z0-9-]{0,62}$/
Example generated
{
  "name": "example",
  "settings": {},
  "slug": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
created_at
required
string format: date-time
id
required
string format: uuid
is_default
required
boolean
name
required
string
settings
object
key
additional properties
any
slug
required
string
/^[a-z0-9][a-z0-9-]{0,62}$/
status
required
string
Allowed values: active inactive
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer format: int64
Example 
{
  "status": "active"
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}