Skip to content

Update Constitution

PUT
/api/v1/settings/constitutions/{role}
curl --request PUT \
--url https://api.ultimateteam.ai/api/v1/settings/constitutions/example \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "yaml": "example" }'

Upsert the charter for role from a YAML body.

Client- and server-side validation:

  • Role must be one of the 8 C-suite codes.
  • Body must parse as YAML.
  • core_values must be a non-empty list.
  • risk_appetite_prior must be in [0, 1].
  • communication_style.forbidden_phrases key must be present.
role
required
Role
string
Media typeapplication/json
ConstitutionUpdateRequest
object
yaml
required
Yaml
string
>= 10 characters <= 50000 characters
Examplegenerated
{
"yaml": "example"
}

Successful Response

Media typeapplication/json
ConstitutionResponse

A single role charter rendered for the settings UI.

object
communication_style
required
Communication Style
object
key
additional properties
any
core_values
required
Core Values
Array<string>
decision_heuristics
required
Decision Heuristics
Array<string>
risk_appetite_prior
required
Risk Appetite Prior
number
role
required
Role
string
version
required
Version
integer
yaml
required
Yaml
string
Examplegenerated
{
"communication_style": {},
"core_values": [
"example"
],
"decision_heuristics": [
"example"
],
"risk_appetite_prior": 1,
"role": "example",
"version": 1,
"yaml": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}