Skip to content
Docs
Select language:English

/api/v1/ai/providers/{ref} (PUT)

PUT
/api/v1/ai/providers/{ref}
curl --request PUT \
  --url https://example.com/api/v1/ai/providers/example \
  --header 'Content-Type: application/json' \
  --data '{ "apiKey": "example", "kind": "openai", "baseUrl": "example", "models": { "vision": "example", "chat": "example", "embeddings": "example" }, "reasoning": "none", "label": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string
<= 40 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
apiKey
string
>= 8 characters <= 500 characters
kind
string
Allowed values: openai anthropic google openai_compatible openrouter groq
baseUrl
string
<= 300 characters
models
object
vision
string
>= 1 characters <= 120 characters
chat
string
>= 1 characters <= 120 characters
embeddings
string
>= 1 characters <= 120 characters
reasoning
string
Allowed values: none minimal low medium high provider-default
label
string
<= 60 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
scope
required
string
Allowed values: instance account user
kind
required
string
Allowed values: openai anthropic google openai_compatible openrouter groq
label
required
string | null
baseUrl
required
string | null
keyHint
required
string | null
models
required
object
vision
string
>= 1 characters <= 120 characters
chat
string
>= 1 characters <= 120 characters
embeddings
string
>= 1 characters <= 120 characters
capabilities
required
object
vision
boolean
structured
boolean
reasoning
required
string
Allowed values: none minimal low medium high provider-default
disabled
required
boolean
rowVersion
required
number
Example
{
  "scope": "instance",
  "kind": "openai",
  "reasoning": "none"
}