AI Chat Plugin

Update an AI provider credential.

PUT

http://localhost:3000/api/ai-chat/credentials/{id}

curl -X PUT 'http://localhost:3000/api/ai-chat/credentials/string' \
  -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/string', {
  method: 'PUT',
  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.put(
    'http://localhost:3000/api/ai-chat/credentials/string',
    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

organizationobject

organizationIdstring

sentTostring

providerIdstring

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

Parameters

idstringrequiredpath

Response

200OK

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

404Not Found

Record not found

Stack Overflow Website Demo