curl --request POST \
--url https://app.apigene.ai/api/user/settings/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_starters": [
{
"name": "<string>",
"action": [
{
"api_name": "<string>",
"domain_url": "<string>",
"user_input": "<string>"
}
]
}
],
"dark_mode": "<string>",
"personal_context": {
"name": "<string>",
"position": "<string>",
"traits": "<string>",
"additional_personalization": [
{}
]
},
"enable_follow_up_suggestions": true,
"prompt_presets": [
{
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"agent_id": "<string>",
"agent_name": "<string>"
}
]
}
'import requests
url = "https://app.apigene.ai/api/user/settings/update"
payload = {
"conversation_starters": [
{
"name": "<string>",
"action": [
{
"api_name": "<string>",
"domain_url": "<string>",
"user_input": "<string>"
}
]
}
],
"dark_mode": "<string>",
"personal_context": {
"name": "<string>",
"position": "<string>",
"traits": "<string>",
"additional_personalization": [{}]
},
"enable_follow_up_suggestions": True,
"prompt_presets": [
{
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"agent_id": "<string>",
"agent_name": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversation_starters: [
{
name: '<string>',
action: [{api_name: '<string>', domain_url: '<string>', user_input: '<string>'}]
}
],
dark_mode: '<string>',
personal_context: {
name: '<string>',
position: '<string>',
traits: '<string>',
additional_personalization: [{}]
},
enable_follow_up_suggestions: true,
prompt_presets: [
{
id: '<string>',
name: '<string>',
prompt: '<string>',
agent_id: '<string>',
agent_name: '<string>'
}
]
})
};
fetch('https://app.apigene.ai/api/user/settings/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.apigene.ai/api/user/settings/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conversation_starters' => [
[
'name' => '<string>',
'action' => [
[
'api_name' => '<string>',
'domain_url' => '<string>',
'user_input' => '<string>'
]
]
]
],
'dark_mode' => '<string>',
'personal_context' => [
'name' => '<string>',
'position' => '<string>',
'traits' => '<string>',
'additional_personalization' => [
[
]
]
],
'enable_follow_up_suggestions' => true,
'prompt_presets' => [
[
'id' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'agent_id' => '<string>',
'agent_name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.apigene.ai/api/user/settings/update"
payload := strings.NewReader("{\n \"conversation_starters\": [\n {\n \"name\": \"<string>\",\n \"action\": [\n {\n \"api_name\": \"<string>\",\n \"domain_url\": \"<string>\",\n \"user_input\": \"<string>\"\n }\n ]\n }\n ],\n \"dark_mode\": \"<string>\",\n \"personal_context\": {\n \"name\": \"<string>\",\n \"position\": \"<string>\",\n \"traits\": \"<string>\",\n \"additional_personalization\": [\n {}\n ]\n },\n \"enable_follow_up_suggestions\": true,\n \"prompt_presets\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.apigene.ai/api/user/settings/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_starters\": [\n {\n \"name\": \"<string>\",\n \"action\": [\n {\n \"api_name\": \"<string>\",\n \"domain_url\": \"<string>\",\n \"user_input\": \"<string>\"\n }\n ]\n }\n ],\n \"dark_mode\": \"<string>\",\n \"personal_context\": {\n \"name\": \"<string>\",\n \"position\": \"<string>\",\n \"traits\": \"<string>\",\n \"additional_personalization\": [\n {}\n ]\n },\n \"enable_follow_up_suggestions\": true,\n \"prompt_presets\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.apigene.ai/api/user/settings/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_starters\": [\n {\n \"name\": \"<string>\",\n \"action\": [\n {\n \"api_name\": \"<string>\",\n \"domain_url\": \"<string>\",\n \"user_input\": \"<string>\"\n }\n ]\n }\n ],\n \"dark_mode\": \"<string>\",\n \"personal_context\": {\n \"name\": \"<string>\",\n \"position\": \"<string>\",\n \"traits\": \"<string>\",\n \"additional_personalization\": [\n {}\n ]\n },\n \"enable_follow_up_suggestions\": true,\n \"prompt_presets\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Settings Update
Endpoint to update user-specific settings.
Compares the provided settings with existing stored settings for the authenticated user. If changes are detected, the settings are updated accordingly. If no settings exist, a new settings record is created for the user.
Args:
payload (Settings): A Settings object containing updated user preferences or values.
Returns: dict: A confirmation message indicating whether the settings were updated or skipped.
Raises: HTTPException 500: If a runtime error occurs during update.
curl --request POST \
--url https://app.apigene.ai/api/user/settings/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_starters": [
{
"name": "<string>",
"action": [
{
"api_name": "<string>",
"domain_url": "<string>",
"user_input": "<string>"
}
]
}
],
"dark_mode": "<string>",
"personal_context": {
"name": "<string>",
"position": "<string>",
"traits": "<string>",
"additional_personalization": [
{}
]
},
"enable_follow_up_suggestions": true,
"prompt_presets": [
{
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"agent_id": "<string>",
"agent_name": "<string>"
}
]
}
'import requests
url = "https://app.apigene.ai/api/user/settings/update"
payload = {
"conversation_starters": [
{
"name": "<string>",
"action": [
{
"api_name": "<string>",
"domain_url": "<string>",
"user_input": "<string>"
}
]
}
],
"dark_mode": "<string>",
"personal_context": {
"name": "<string>",
"position": "<string>",
"traits": "<string>",
"additional_personalization": [{}]
},
"enable_follow_up_suggestions": True,
"prompt_presets": [
{
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"agent_id": "<string>",
"agent_name": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversation_starters: [
{
name: '<string>',
action: [{api_name: '<string>', domain_url: '<string>', user_input: '<string>'}]
}
],
dark_mode: '<string>',
personal_context: {
name: '<string>',
position: '<string>',
traits: '<string>',
additional_personalization: [{}]
},
enable_follow_up_suggestions: true,
prompt_presets: [
{
id: '<string>',
name: '<string>',
prompt: '<string>',
agent_id: '<string>',
agent_name: '<string>'
}
]
})
};
fetch('https://app.apigene.ai/api/user/settings/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.apigene.ai/api/user/settings/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'conversation_starters' => [
[
'name' => '<string>',
'action' => [
[
'api_name' => '<string>',
'domain_url' => '<string>',
'user_input' => '<string>'
]
]
]
],
'dark_mode' => '<string>',
'personal_context' => [
'name' => '<string>',
'position' => '<string>',
'traits' => '<string>',
'additional_personalization' => [
[
]
]
],
'enable_follow_up_suggestions' => true,
'prompt_presets' => [
[
'id' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'agent_id' => '<string>',
'agent_name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.apigene.ai/api/user/settings/update"
payload := strings.NewReader("{\n \"conversation_starters\": [\n {\n \"name\": \"<string>\",\n \"action\": [\n {\n \"api_name\": \"<string>\",\n \"domain_url\": \"<string>\",\n \"user_input\": \"<string>\"\n }\n ]\n }\n ],\n \"dark_mode\": \"<string>\",\n \"personal_context\": {\n \"name\": \"<string>\",\n \"position\": \"<string>\",\n \"traits\": \"<string>\",\n \"additional_personalization\": [\n {}\n ]\n },\n \"enable_follow_up_suggestions\": true,\n \"prompt_presets\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.apigene.ai/api/user/settings/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_starters\": [\n {\n \"name\": \"<string>\",\n \"action\": [\n {\n \"api_name\": \"<string>\",\n \"domain_url\": \"<string>\",\n \"user_input\": \"<string>\"\n }\n ]\n }\n ],\n \"dark_mode\": \"<string>\",\n \"personal_context\": {\n \"name\": \"<string>\",\n \"position\": \"<string>\",\n \"traits\": \"<string>\",\n \"additional_personalization\": [\n {}\n ]\n },\n \"enable_follow_up_suggestions\": true,\n \"prompt_presets\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.apigene.ai/api/user/settings/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_starters\": [\n {\n \"name\": \"<string>\",\n \"action\": [\n {\n \"api_name\": \"<string>\",\n \"domain_url\": \"<string>\",\n \"user_input\": \"<string>\"\n }\n ]\n }\n ],\n \"dark_mode\": \"<string>\",\n \"personal_context\": {\n \"name\": \"<string>\",\n \"position\": \"<string>\",\n \"traits\": \"<string>\",\n \"additional_personalization\": [\n {}\n ]\n },\n \"enable_follow_up_suggestions\": true,\n \"prompt_presets\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'
Body
conversational starters.
Show child attributes
Show child attributes
User dark mode information.
User personal context information.
Show child attributes
Show child attributes
When true, show follow-up suggestion chips after assistant responses. Defaults to disabled when unset.
Personal prompt presets (name, prompt text, optional agent).
Show child attributes
Show child attributes
Response
Successful Response
