/api/v1/ai/providers

GET

const url = 'https://example.com/api/v1/ai/providers';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/ai/providers

Responses

200

Default Response

application/json

object

providers

required

Array<object>

object

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

{
  "providers": [
    {
      "scope": "instance",
      "kind": "openai",
      "reasoning": "none"
    }
  ]
}