/ai-settings (PUT)

PUT

/ai-settings

curl --request PUT \
  --url https://example.com/api/v1/ai-settings \
  --header 'Content-Type: application/json' \
  --data '{ "apiKey": "example", "model": "example", "enabled": true }'

Request Body ^required

Media type application/json

object

apiKey

string

>= 8 characters <= 256 characters

model

string

>= 1 characters <= 64 characters

enabled

boolean

Example ^generated

{
  "apiKey": "example",
  "model": "example",
  "enabled": true
}

Responses

200

Default Response

Media type application/json

object

enabled

required

boolean

configured

required

boolean

keySource

required

Any of:

string

string

Allowed values: org

string

string

Allowed values: platform

string

string

Allowed values: none

keyHint

required

Any of:

string

string

null

null

model

required

string

Example

{
  "keySource": "org"
}

400

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}