Create a platform-wide AI provider

Creates a new instance-wide AI provider (`orgId` is null).…

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/admin/ai-providers" \  -H "Content-Type: application/json" \  -d '{    "label": "Primary platform provider",    "providerType": "openai",    "apiKey": "provider-api-key",    "model": "example-model",    "baseUrl": "https://api.example.com/v1",    "thinkingMode": "provider_default",    "openAiEndpointMode": "chat_completions",    "maxOutputTokensField": "max_tokens",    "supportsThinkingMode": false,    "minimumThinkingTokens": null,    "omitSamplingWhenThinking": false,    "inputCostPer1MUncached": 2.5,    "inputCostPer1MCached": 1.25,    "outputCostPer1M": 10  }'

{
  "id": "22222222-2222-4222-8222-222222222222",
  "label": "Primary platform provider",
  "providerType": "openai",
  "model": "example-model",
  "baseUrl": "https://api.example.com/v1",
  "thinkingMode": "provider_default",
  "openAiEndpointMode": "chat_completions",
  "maxOutputTokensField": "max_tokens",
  "supportsThinkingMode": false,
  "minimumThinkingTokens": null,
  "omitSamplingWhenThinking": false,
  "hasApiKey": true,
  "inputCostPer1MUncached": 2.5,
  "inputCostPer1MCached": 1.25,
  "outputCostPer1M": 10,
  "enabled": true,
  "priority": 0,
  "scheduleEnabled": false,
  "scheduleStart": "00:00",
  "scheduleEnd": "23:59",
  "scheduleTimezone": "UTC",
  "consecutiveFailures": 0,
  "circuitOpenUntil": null,
  "lastError": null
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Try it

Base URLAPI keyRequest body (JSON)

Your API key is sent directly to the Convor API from your browser and is never stored on this site.

Was this page helpful?

Create a platform-wide AI provider

Creates a new instance-wide AI provider (`orgId` is null).…

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

label*string

providerType*string

model*string

baseUrl*string

thinkingMode?string

openAiEndpointMode?string

maxOutputTokensField?string

supportsThinkingMode?boolean

minimumThinkingTokens?|

omitSamplingWhenThinking?boolean

apiKey?string

inputCostPer1MUncached?number

inputCostPer1MCached?number

outputCostPer1M?number

enabled?boolean

priority?integer

scheduleEnabled?boolean

scheduleStart?string

scheduleEnd?string

scheduleTimezone?string

Response Body

`application/json`

curl -X POST "https://example.com/api/admin/ai-providers" \  -H "Content-Type: application/json" \  -d '{    "label": "Primary platform provider",    "providerType": "openai",    "apiKey": "provider-api-key",    "model": "example-model",    "baseUrl": "https://api.example.com/v1",    "thinkingMode": "provider_default",    "openAiEndpointMode": "chat_completions",    "maxOutputTokensField": "max_tokens",    "supportsThinkingMode": false,    "minimumThinkingTokens": null,    "omitSamplingWhenThinking": false,    "inputCostPer1MUncached": 2.5,    "inputCostPer1MCached": 1.25,    "outputCostPer1M": 10  }'

{
  "id": "22222222-2222-4222-8222-222222222222",
  "label": "Primary platform provider",
  "providerType": "openai",
  "model": "example-model",
  "baseUrl": "https://api.example.com/v1",
  "thinkingMode": "provider_default",
  "openAiEndpointMode": "chat_completions",
  "maxOutputTokensField": "max_tokens",
  "supportsThinkingMode": false,
  "minimumThinkingTokens": null,
  "omitSamplingWhenThinking": false,
  "hasApiKey": true,
  "inputCostPer1MUncached": 2.5,
  "inputCostPer1MCached": 1.25,
  "outputCostPer1M": 10,
  "enabled": true,
  "priority": 0,
  "scheduleEnabled": false,
  "scheduleStart": "00:00",
  "scheduleEnd": "23:59",
  "scheduleTimezone": "UTC",
  "consecutiveFailures": 0,
  "circuitOpenUntil": null,
  "lastError": null
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Try it

Base URLAPI keyRequest body (JSON)

Your API key is sent directly to the Convor API from your browser and is never stored on this site.

Was this page helpful?

Create a platform-wide AI provider

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Create a platform-wide AI provider

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`