Configure Provider creates or updates a provider configuration

POST/v1/providers/{providerName}/configure

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

providerName (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`providerName`	path	`string`	Yes

Request Body

Property	Type	Required
`apiKey`	`string`	No
`enabledModels`	`string[]`	No
`customBaseUrl`	`string`	No
`customSettings`	`object`	No

Responses

200 Provider configured successfully

Property	Type	Description
`provider`	`object`
`syncTriggered`	`boolean`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/providers/{providerName}/configure" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"apiKey":"string","enabledModels":["string"],"customBaseUrl":"string"}'

const response = await fetch("http://localhost:8089/v1/providers/{providerName}/configure", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "apiKey": "string",
  "enabledModels": [
    "string"
  ],
  "customBaseUrl": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/providers/{providerName}/configure",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "apiKey": "string",
  "enabledModels": [
    "string"
  ],
  "customBaseUrl": "string"
},
)
data = response.json()

Response

{
  "provider": {
    "catalog": {
      "name": "string",
      "displayName": "string",
      "baseUrl": "string",
      "apiVersion": "string",
      "capabilities": {
        "chat": true,
        "completions": true,
        "embeddings": true,
        "functionCalling": true,
        "vision": true,
        "streaming": true,
        "fineTuning": true,
        "assistants": true
      },
      "modelFamilies": [],
      "models": [],
      "rateLimits": {
        "requestsPerMinute": 0,
        "tokensPerMinute": 0,
        "concurrentRequests": 0
      },
      "description": "string",
      "providerType": "string",
      "supportsModelDiscovery": true,
      "discoveryApiEndpoint": "string"
    },
    "configuration": {
      "id": "string",
      "providerName": "string",
      "apiKey": "string",
      "enabledModels": [
        "string"
      ],
      "customBaseUrl": "string",
      "isActive": true,
      "createdAt": "string",
      "updatedAt": "string",
      "syncedToYamlAt": "string",
      "lastUsedAt": "string"
    },
    "isConfigured": true,
    "isActive": true,
    "configuredModelsCount": 0,
    "availableModelsCount": 0,
    "catalogStatus": "string",
    "isFromCatalog": true
  },
  "syncTriggered": true
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}