Skip to content
QuantCDN

Save the auto mode setting for an organisation

PUT
/api/v3/organizations/{organisation}/ai/auto-mode
curl --request PUT \
  --url https://dashboard.quantcdn.io/api/v3/organizations/example/ai/auto-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "orchestratorModel": "example", "group": { "revision": 1, "roles": { "fast": [ "example" ], "standard": [ "example" ], "deep": [ "example" ] } }, "watcherIntervalMinutes": 1, "maxParallelTasks": 1, "enforcement": "default", "autonomousDefault": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organisation
required
string

The organisation ID

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
required
boolean
orchestratorModel

Required when enabled is true. May be left out when enabled is false.

string
group
required
object
revision

Revision from the last read. A stale value returns 409.

integer
roles
required
object
fast
required
Array<string>
<= 5 items
standard
required
Array<string>
<= 5 items
deep
required
Array<string>
<= 5 items
watcherIntervalMinutes
required
integer
<= 60
maxParallelTasks
integer
>= 1 <= 16
enforcement
required
string
Allowed values: default required
autonomousDefault
required
boolean

Responses

Section titled “Responses”

200

Section titled “200”

The saved setting

Media typeapplication/json
object
autoMode
object
enabled
required
boolean
orchestratorModel
required

Empty when the setting was saved off without an orchestrator.

string
group
required
object
revision
required
integer
roles
required
object
fast
required
Array<string>
<= 5 items
standard
required
Array<string>
<= 5 items
deep
required
Array<string>
<= 5 items
watcherIntervalMinutes
required
integer
<= 60
maxParallelTasks
integer
>= 1 <= 16
enforcement
required
string
Allowed values: default required
autonomousDefault
required
boolean
updatedAt
required
string
updatedBy
string
Example
{
  "autoMode": {
    "enforcement": "default"
  }
}

400

Section titled “400”

The setting is refused. When the models are not usable, eligible carries the eligibility report; it is null for a body shape error or an unknown organisation portal.

Media typeapplication/json
object
error
required
string
eligible
One of:
object
orchestrator
required
One of:
object
modelId
required
string
resolvedId
required
string
eligible
required
boolean
reason
string
Allowed values: unknown no_tools policy residency
roles
required
object
fast
required
Array<object>
object
modelId
required
string
resolvedId
required
string
eligible
required
boolean
reason
string
Allowed values: unknown no_tools policy residency
standard
required
Array<object>
object
modelId
required
string
resolvedId
required
string
eligible
required
boolean
reason
string
Allowed values: unknown no_tools policy residency
deep
required
Array<object>
object
modelId
required
string
resolvedId
required
string
eligible
required
boolean
reason
string
Allowed values: unknown no_tools policy residency
usable
required
boolean
Example
{
  "eligible": {
    "orchestrator": {
      "reason": "unknown"
    },
    "roles": {
      "fast": [
        {
          "reason": "unknown"
        }
      ],
      "standard": [
        {
          "reason": "unknown"
        }
      ],
      "deep": [
        {
          "reason": "unknown"
        }
      ]
    }
  }
}

409

Section titled “409”

Conflict: the group revision is stale (another change was saved after the last read), the governance settings changed between the read and the write, or the organisation governance settings are not saved yet (error: “Save the organisation governance settings first”). Read the setting again, then retry.

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

422

Section titled “422”

Validation error

502

Section titled “502”

The AI service is not available

503

Section titled “503”

The AI service cannot save the setting now