Core AI Settings API

All the relevant APIs needed to modify Core AI setting of your Convai Character.

This API is available only with the Professional Plan and above.

Character Model Selection

POST https://api.convai.com/character/update

Update API can be used to change the LLM to be used for Character. Currently following models are supported.

OpenAI

Model	Model Code	Uncensored	Flagship
GPT-4.1	gpt-4.1
GPT-4.1-mini	gpt-4.1-mini
GPT-4.1-nano	gpt-4.1-nano
GPT-4o	gpt-4o
GPT-4o-mini	gpt-4o-mini

Anthropic

Model	Model Code	Uncensored	Flagship
Claude-Opus-4.1	claude-opus-4.1
Claude-Opus-4	claude-opus-4
Claude-4-Sonnet	claude-4-sonnet
Claude-3-7-Sonnet	claude-3-7-sonnet

Google

Model	Model Code	Uncensored	Flagship
Gemini-2.5-Flash	gemini-2.5-flash
Gemini-2.5-Flash-Lite	gemini-2.5-flash-lite
Gemini-2.0-Flash	gemini-2.0-flash
Gemma-3n-e4b	gemma-3n-e4b
Gemma-3n-e2b	gemma-3n-e2b

Llama

Model	Model Code	Uncensored	Flagship
LLama-4-Maverick	llama-4-maverick
LLama-4-Scout	llama-4-scout
LLama-3.3-70B	llama-3-70B

When calling update API to update Model for your Character, please ensure to pass the Model Code corresponding to the Model from the table above.

Headers

Name	Type	Description
CONVAI-API-KEY*	String	The unique api-key provided for every user. Found under the Key icon when logged into your Convai account.

Request Body

Name	Type	Description
charID	String	Id of your character.
model_group_name	String	Model Code of the Model to which you want to update. See the table above.

200: OK The model has been sucessfuly updated.

{"STATUS": "SUCCESS"}

401 API Key validation has failed

Here are some sample codes to demonstrate the request format for the endpoint -->

Python

import requests
import json

url = "https://api.convai.com/character/update"

headers = { 
    'CONVAI-API-KEY': '<Your-API-Key>',
    'Content-Type': 'application/json'
}

# Create a dictionary for the JSON payload
payload = { 
    "charID": "<Your-Character-Id>",
    "model_group_name": "claude-3-5-sonnet"
}

# Convert the payload to JSON
json_payload = json.dumps(payload)

response = requests.post(url, headers=headers, data=json_payload)

print(response.text)

cURL

Temperature Setting

POST https://api.convai.com/character/update

When chatting with AI, the temperature setting is like adjusting how creative or predictable the responses will be. A lower temperature makes the AI stick closer to what it knows for sure (Less Hallucinations), while a higher temperature lets it get more imaginative and potentially surprising (better Role Play).

Headers

Name	Type	Description
CONVAI-API-KEY*	String	The unique api-key provided for every user. Found under the Key icon when logged into your Convai account.

Request Body

Name	Type	Description
charID	String	Id of your character.
temperature	Float	Temperature value. Must be between 0 and 1.

200: OK Temperature Successfully Updated

{"STATUS": "SUCCESS"}

401 API Key validation has failed

Here are some sample codes to demonstrate the request format for the endpoint -->

Python

import requests
import json

url = "https://api.convai.com/character/update"

headers = { 
    'CONVAI-API-KEY': '<Your-API-Key>',
    'Content-Type': 'application/json'
}

# Create a dictionary for the JSON payload
payload = { 
    "charID": "<Your-Character-Id>",
    "temperature": 0.42
}

# Convert the payload to JSON
json_payload = json.dumps(payload)

response = requests.post(url, headers=headers, data=json_payload)

print(response.text)

cURL