Create a character
curl --request POST \
--url https://api.alakazam.gg/v1/characters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"world": {},
"name": "<string>",
"authored": true,
"premise": "<string>",
"frame_b64": "<string>",
"frame_url": "<string>",
"cover": "<string>",
"subject": "<string>",
"style": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"stances": [
{
"id": "<string>",
"label": "<string>",
"mood": "<string>",
"expression": "<string>"
}
],
"entranceState": "<string>",
"cameraStatic": "<string>",
"cameraDynamic": "<string>",
"movementStatic": "<string>",
"movementDynamic": "<string>",
"speakingDetail": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": true,
"intro": {
"kicker": "<string>",
"title": "<string>",
"hint": "<string>"
}
}
'import requests
url = "https://api.alakazam.gg/v1/characters"
payload = {
"world": {},
"name": "<string>",
"authored": True,
"premise": "<string>",
"frame_b64": "<string>",
"frame_url": "<string>",
"cover": "<string>",
"subject": "<string>",
"style": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"stances": [
{
"id": "<string>",
"label": "<string>",
"mood": "<string>",
"expression": "<string>"
}
],
"entranceState": "<string>",
"cameraStatic": "<string>",
"cameraDynamic": "<string>",
"movementStatic": "<string>",
"movementDynamic": "<string>",
"speakingDetail": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": True,
"intro": {
"kicker": "<string>",
"title": "<string>",
"hint": "<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({
world: {},
name: '<string>',
authored: true,
premise: '<string>',
frame_b64: '<string>',
frame_url: '<string>',
cover: '<string>',
subject: '<string>',
style: '<string>',
persona: '<string>',
scene: '<string>',
greeting: '<string>',
lore: '<string>',
examples: '<string>',
stances: [{id: '<string>', label: '<string>', mood: '<string>', expression: '<string>'}],
entranceState: '<string>',
cameraStatic: '<string>',
cameraDynamic: '<string>',
movementStatic: '<string>',
movementDynamic: '<string>',
speakingDetail: '<string>',
voiceId: '<string>',
modelId: '<string>',
free: true,
intro: {kicker: '<string>', title: '<string>', hint: '<string>'}
})
};
fetch('https://api.alakazam.gg/v1/characters', 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",
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([
'world' => [
],
'name' => '<string>',
'authored' => true,
'premise' => '<string>',
'frame_b64' => '<string>',
'frame_url' => '<string>',
'cover' => '<string>',
'subject' => '<string>',
'style' => '<string>',
'persona' => '<string>',
'scene' => '<string>',
'greeting' => '<string>',
'lore' => '<string>',
'examples' => '<string>',
'stances' => [
[
'id' => '<string>',
'label' => '<string>',
'mood' => '<string>',
'expression' => '<string>'
]
],
'entranceState' => '<string>',
'cameraStatic' => '<string>',
'cameraDynamic' => '<string>',
'movementStatic' => '<string>',
'movementDynamic' => '<string>',
'speakingDetail' => '<string>',
'voiceId' => '<string>',
'modelId' => '<string>',
'free' => true,
'intro' => [
'kicker' => '<string>',
'title' => '<string>',
'hint' => '<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://api.alakazam.gg/v1/characters"
payload := strings.NewReader("{\n \"world\": {},\n \"name\": \"<string>\",\n \"authored\": true,\n \"premise\": \"<string>\",\n \"frame_b64\": \"<string>\",\n \"frame_url\": \"<string>\",\n \"cover\": \"<string>\",\n \"subject\": \"<string>\",\n \"style\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"stances\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"mood\": \"<string>\",\n \"expression\": \"<string>\"\n }\n ],\n \"entranceState\": \"<string>\",\n \"cameraStatic\": \"<string>\",\n \"cameraDynamic\": \"<string>\",\n \"movementStatic\": \"<string>\",\n \"movementDynamic\": \"<string>\",\n \"speakingDetail\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true,\n \"intro\": {\n \"kicker\": \"<string>\",\n \"title\": \"<string>\",\n \"hint\": \"<string>\"\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://api.alakazam.gg/v1/characters")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"world\": {},\n \"name\": \"<string>\",\n \"authored\": true,\n \"premise\": \"<string>\",\n \"frame_b64\": \"<string>\",\n \"frame_url\": \"<string>\",\n \"cover\": \"<string>\",\n \"subject\": \"<string>\",\n \"style\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"stances\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"mood\": \"<string>\",\n \"expression\": \"<string>\"\n }\n ],\n \"entranceState\": \"<string>\",\n \"cameraStatic\": \"<string>\",\n \"cameraDynamic\": \"<string>\",\n \"movementStatic\": \"<string>\",\n \"movementDynamic\": \"<string>\",\n \"speakingDetail\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true,\n \"intro\": {\n \"kicker\": \"<string>\",\n \"title\": \"<string>\",\n \"hint\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/characters")
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 \"world\": {},\n \"name\": \"<string>\",\n \"authored\": true,\n \"premise\": \"<string>\",\n \"frame_b64\": \"<string>\",\n \"frame_url\": \"<string>\",\n \"cover\": \"<string>\",\n \"subject\": \"<string>\",\n \"style\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"stances\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"mood\": \"<string>\",\n \"expression\": \"<string>\"\n }\n ],\n \"entranceState\": \"<string>\",\n \"cameraStatic\": \"<string>\",\n \"cameraDynamic\": \"<string>\",\n \"movementStatic\": \"<string>\",\n \"movementDynamic\": \"<string>\",\n \"speakingDetail\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true,\n \"intro\": {\n \"kicker\": \"<string>\",\n \"title\": \"<string>\",\n \"hint\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"kind": "character",
"cover": "<string>",
"schemaVersion": "1.0",
"mock": true
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"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).
Headers
A retried request with the same key returns the original result without re-creating.
Body
IMPORT mode: a complete character world (world.scene + world.character).
AUTHORED mode: invent the profile + stances from a frame/premise.
An explicit cover/seed-frame URL.
EXPLICIT: the anti-drift visual SUBJECT lock.
EXPLICIT: the visual STYLE phrase.
EXPLICIT: who they are (the brain).
EXPLICIT: the emotional stance palette; each is one visual state + a brain mood.
Show child attributes
Show child attributes
EXPLICIT, stance id to start in (defaults to the first stance).
EXPLICIT, camera framing for still shots (prose).
EXPLICIT, camera framing while moving (prose; defaults to cameraStatic).
EXPLICIT, how the character holds still (prose).
EXPLICIT, how the character moves (prose; defaults to movementStatic).
EXPLICIT, speaking-animation detail (prose).
ElevenLabs voice id.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.alakazam.gg/v1/characters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"world": {},
"name": "<string>",
"authored": true,
"premise": "<string>",
"frame_b64": "<string>",
"frame_url": "<string>",
"cover": "<string>",
"subject": "<string>",
"style": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"stances": [
{
"id": "<string>",
"label": "<string>",
"mood": "<string>",
"expression": "<string>"
}
],
"entranceState": "<string>",
"cameraStatic": "<string>",
"cameraDynamic": "<string>",
"movementStatic": "<string>",
"movementDynamic": "<string>",
"speakingDetail": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": true,
"intro": {
"kicker": "<string>",
"title": "<string>",
"hint": "<string>"
}
}
'import requests
url = "https://api.alakazam.gg/v1/characters"
payload = {
"world": {},
"name": "<string>",
"authored": True,
"premise": "<string>",
"frame_b64": "<string>",
"frame_url": "<string>",
"cover": "<string>",
"subject": "<string>",
"style": "<string>",
"persona": "<string>",
"scene": "<string>",
"greeting": "<string>",
"lore": "<string>",
"examples": "<string>",
"stances": [
{
"id": "<string>",
"label": "<string>",
"mood": "<string>",
"expression": "<string>"
}
],
"entranceState": "<string>",
"cameraStatic": "<string>",
"cameraDynamic": "<string>",
"movementStatic": "<string>",
"movementDynamic": "<string>",
"speakingDetail": "<string>",
"voiceId": "<string>",
"modelId": "<string>",
"free": True,
"intro": {
"kicker": "<string>",
"title": "<string>",
"hint": "<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({
world: {},
name: '<string>',
authored: true,
premise: '<string>',
frame_b64: '<string>',
frame_url: '<string>',
cover: '<string>',
subject: '<string>',
style: '<string>',
persona: '<string>',
scene: '<string>',
greeting: '<string>',
lore: '<string>',
examples: '<string>',
stances: [{id: '<string>', label: '<string>', mood: '<string>', expression: '<string>'}],
entranceState: '<string>',
cameraStatic: '<string>',
cameraDynamic: '<string>',
movementStatic: '<string>',
movementDynamic: '<string>',
speakingDetail: '<string>',
voiceId: '<string>',
modelId: '<string>',
free: true,
intro: {kicker: '<string>', title: '<string>', hint: '<string>'}
})
};
fetch('https://api.alakazam.gg/v1/characters', 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",
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([
'world' => [
],
'name' => '<string>',
'authored' => true,
'premise' => '<string>',
'frame_b64' => '<string>',
'frame_url' => '<string>',
'cover' => '<string>',
'subject' => '<string>',
'style' => '<string>',
'persona' => '<string>',
'scene' => '<string>',
'greeting' => '<string>',
'lore' => '<string>',
'examples' => '<string>',
'stances' => [
[
'id' => '<string>',
'label' => '<string>',
'mood' => '<string>',
'expression' => '<string>'
]
],
'entranceState' => '<string>',
'cameraStatic' => '<string>',
'cameraDynamic' => '<string>',
'movementStatic' => '<string>',
'movementDynamic' => '<string>',
'speakingDetail' => '<string>',
'voiceId' => '<string>',
'modelId' => '<string>',
'free' => true,
'intro' => [
'kicker' => '<string>',
'title' => '<string>',
'hint' => '<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://api.alakazam.gg/v1/characters"
payload := strings.NewReader("{\n \"world\": {},\n \"name\": \"<string>\",\n \"authored\": true,\n \"premise\": \"<string>\",\n \"frame_b64\": \"<string>\",\n \"frame_url\": \"<string>\",\n \"cover\": \"<string>\",\n \"subject\": \"<string>\",\n \"style\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"stances\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"mood\": \"<string>\",\n \"expression\": \"<string>\"\n }\n ],\n \"entranceState\": \"<string>\",\n \"cameraStatic\": \"<string>\",\n \"cameraDynamic\": \"<string>\",\n \"movementStatic\": \"<string>\",\n \"movementDynamic\": \"<string>\",\n \"speakingDetail\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true,\n \"intro\": {\n \"kicker\": \"<string>\",\n \"title\": \"<string>\",\n \"hint\": \"<string>\"\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://api.alakazam.gg/v1/characters")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"world\": {},\n \"name\": \"<string>\",\n \"authored\": true,\n \"premise\": \"<string>\",\n \"frame_b64\": \"<string>\",\n \"frame_url\": \"<string>\",\n \"cover\": \"<string>\",\n \"subject\": \"<string>\",\n \"style\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"stances\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"mood\": \"<string>\",\n \"expression\": \"<string>\"\n }\n ],\n \"entranceState\": \"<string>\",\n \"cameraStatic\": \"<string>\",\n \"cameraDynamic\": \"<string>\",\n \"movementStatic\": \"<string>\",\n \"movementDynamic\": \"<string>\",\n \"speakingDetail\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true,\n \"intro\": {\n \"kicker\": \"<string>\",\n \"title\": \"<string>\",\n \"hint\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/characters")
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 \"world\": {},\n \"name\": \"<string>\",\n \"authored\": true,\n \"premise\": \"<string>\",\n \"frame_b64\": \"<string>\",\n \"frame_url\": \"<string>\",\n \"cover\": \"<string>\",\n \"subject\": \"<string>\",\n \"style\": \"<string>\",\n \"persona\": \"<string>\",\n \"scene\": \"<string>\",\n \"greeting\": \"<string>\",\n \"lore\": \"<string>\",\n \"examples\": \"<string>\",\n \"stances\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"mood\": \"<string>\",\n \"expression\": \"<string>\"\n }\n ],\n \"entranceState\": \"<string>\",\n \"cameraStatic\": \"<string>\",\n \"cameraDynamic\": \"<string>\",\n \"movementStatic\": \"<string>\",\n \"movementDynamic\": \"<string>\",\n \"speakingDetail\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"modelId\": \"<string>\",\n \"free\": true,\n \"intro\": {\n \"kicker\": \"<string>\",\n \"title\": \"<string>\",\n \"hint\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"kind": "character",
"cover": "<string>",
"schemaVersion": "1.0",
"mock": true
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}
