Characters
Update a character
Patch metadata + brain fields (persona, greeting, lore, voiceId, stances, intro, free). Graph/stance-node edits go through the /v1/worlds//* endpoints.
PATCH
/
v1
/
characters
/
{id}
Update a character
curl --request PATCH \
--url https://api.alakazam.gg/v1/characters/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"cover": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": true
}
'import requests
url = "https://api.alakazam.gg/v1/characters/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"cover": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
cover: '<string>',
persona: '<string>',
scene: '<string>',
greeting: '<string>',
lore: '<string>',
examples: '<string>',
voiceId: '<string>',
modelId: '<string>',
free: true
})
};
fetch('https://api.alakazam.gg/v1/characters/{id}', 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://api.alakazam.gg/v1/characters/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'cover' => '<string>',
'persona' => '<string>',
'scene' => '<string>',
'greeting' => '<string>',
'lore' => '<string>',
'examples' => '<string>',
'voiceId' => '<string>',
'modelId' => '<string>',
'free' => true
]),
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://api.alakazam.gg/v1/characters/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cover\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.alakazam.gg/v1/characters/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cover\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/characters/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cover\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"cover": "<string>",
"visibility": "private",
"voiceId": "<string>",
"modelId": "<string>",
"free": true,
"greeting": "<string>",
"intro": {},
"stances": [
{
"id": "<string>",
"label": "<string>",
"mood": "<string>"
}
],
"persona": "<string>",
"scene": "<string>",
"lore": "<string>",
"examples": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"schemaVersion": "1.0"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}Authorizations
An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).
Path Parameters
Body
application/json
Response
Updated character
A character (owner view). The brain (persona/lore) is included for the owning app, but NEVER leaves the server on the embed path.
Available options:
private, unlisted, public Show child attributes
Show child attributes
Example:
"1.0"
⌘I
Update a character
curl --request PATCH \
--url https://api.alakazam.gg/v1/characters/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"cover": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": true
}
'import requests
url = "https://api.alakazam.gg/v1/characters/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"cover": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
cover: '<string>',
persona: '<string>',
scene: '<string>',
greeting: '<string>',
lore: '<string>',
examples: '<string>',
voiceId: '<string>',
modelId: '<string>',
free: true
})
};
fetch('https://api.alakazam.gg/v1/characters/{id}', 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://api.alakazam.gg/v1/characters/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'cover' => '<string>',
'persona' => '<string>',
'scene' => '<string>',
'greeting' => '<string>',
'lore' => '<string>',
'examples' => '<string>',
'voiceId' => '<string>',
'modelId' => '<string>',
'free' => true
]),
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://api.alakazam.gg/v1/characters/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cover\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.alakazam.gg/v1/characters/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cover\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/characters/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"cover\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"cover": "<string>",
"visibility": "private",
"voiceId": "<string>",
"modelId": "<string>",
"free": true,
"greeting": "<string>",
"intro": {},
"stances": [
{
"id": "<string>",
"label": "<string>",
"mood": "<string>"
}
],
"persona": "<string>",
"scene": "<string>",
"lore": "<string>",
"examples": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"schemaVersion": "1.0"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}
