Skip to content
Olivares AI docs

Create the first organization and the superadmin that owns it, with the one-time setup token

POST
/v1/setup
 
curl --request POST \
  --url https://example.com/v1/setup \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "organization": "example", "password": "example", "token": "example" }'

Creates the first organization and the superadmin that owns it, using the one-time setup token. It is atomic against a concurrent setup and consumes the token on success.

Authorizations

Section titled “ Authorizations ”
  • None

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
email
required
string format: email
organization

Optional name for the first organization; defaults to “Default Organization”

string
password
required
string format: password
>= 12 characters
token
required

One-time setup token from server startup

string
Example generated 
{
  "email": "hello@example.com",
  "organization": "example",
  "password": "example",
  "token": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
created_at
required
string format: date-time
display_name
string
email
required
string format: email
id
required
string format: uuid
is_superadmin
required
boolean
organization
required
object
created_at
required
string format: date-time
data_region
string
id
required
string format: uuid
name
required
string
slug
required
string
status
required
string
tenant_id
required
string format: uuid
status
required
string
Allowed values: active inactive
Example 
{
  "status": "active"
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}