AI Chat Plugin

Create or update (upsert) an AI provider credential for the current tenant.

POST

http://localhost:3000/api/ai-chat/credentials

curl -X POST 'http://localhost:3000/api/ai-chat/credentials' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "providerId": "string",
  "apiKey": "string",
  "baseUrl": "string",
  "enabled": true,
  "isDefault": false,
  "defaultModel": "string",
  "isVoiceDefault": false,
  "speechModel": "string"
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "providerId": "string",
  "apiKey": "string",
  "baseUrl": "string",
  "enabled": true,
  "isDefault": false,
  "defaultModel": "string",
  "isVoiceDefault": false,
  "speechModel": "string"
}`;

const response = await fetch('http://localhost:3000/api/ai-chat/credentials', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "providerId": "string",
  "apiKey": "string",
  "baseUrl": "string",
  "enabled": true,
  "isDefault": false,
  "defaultModel": "string",
  "isVoiceDefault": false,
  "speechModel": "string"
}'''

response = requests.post(
    'http://localhost:3000/api/ai-chat/credentials',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "providerId": "string",
  "apiKey": "string",
  "baseUrl": "string",
  "enabled": true,
  "isDefault": false,
  "defaultModel": "string",
  "isVoiceDefault": false,
  "speechModel": "string"
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

providerIdstringrequired

AI provider identifier (e.g. anthropic, openai)

apiKeystring

Secret API key (write-only; stored encrypted). Required unless the provider runs without one (local servers).

baseUrlstring

Custom base URL for the provider API

enabledbooleantrue

Whether this credential is active

isDefaultbooleanfalse

Whether this provider is the tenant's default for chat

defaultModelstring | null

Preferred default model id (e.g. claude-sonnet-5); null clears the stored model

isVoiceDefaultbooleanfalse

Whether this provider is the tenant's default voice (dictation) provider

speechModelstring | null

Preferred speech-to-text model id (e.g. whisper-1); null clears the stored model

Response

201Created

The credential has been successfully saved. The API key is returned masked.

400Bad Request

Bad Request

Stack Overflow Website Demo