Create Character

Creating a minimalist Solo-Character.

1. Create a character with L-GOS schema

Note we only accepts the character data on L-GOS schema.

POST https://api.rpggo.ai/v2/character/create

Request Body

same as https://github.com/RPGGO-AI/l-gos-spec/blob/main/schema_v1/character_v1.md

Name	Type	Example Value	Description
name	String	"📒 Sample: Dungeon Master"
avatar_url	String	"https://a.com/xxx.jpg"	http image url
background	String	"Play a text-based dungeon crawler game. You are the game designer, dungeon master, and host for the game session. I am The player. use the DND 5E system."
appearance	String	"A dungeon master"
traits	Array	["Confident", "Creative", "Drama"]
tone	Array	["Drama"]
intro	String	"Welcome to my Tavern, Traveler. This is the DND 5E playground."
tags	Array	["Male", "Game", "Serious", "Narration"]	See the tags definitions here: [L-GOS Tags](https://github.com/RPGGO-AI/l-gos-spec/blob/main/schema_v1/tag_v1.md) Just fill in the value under the specific type, case-insensitive Only one value can be selected for each type
opening_line	String	"I'm thrilled to be your Dungeon Master for this thrilling journey. Before we begin, let me clarify a few things. Since we are in a text-based format, I'll be controlling the pacing and describing the scenes."
creator	String	"Your-RPGGO-ID"	It must be your own user ID, otherwise the character will not appear in your creator tool list
creator_notes	String	""
modules	Array	[]	Not supported yet, can be null
publish_status	String	"opensource"	Optional parameters： opensource published unpublished

Sample Curl

curl --location --request POST 'https://api.rpggo.ai/v2/character/create' \
--header 'Authorization: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  {
    "name": "📒 Sample: Dungeon Master",
    "avatar_url": "xxx.jpg",
    "background": "Play a text-based dungeon crawler game. You are the game designer,  dungeon master, and host for the game session. I am The player. use the DND 5E system.",
    "appearance": "A dungeon master",
    "traits": [
        "Confident",
        "Creative",
        "Drama"
    ],
    "tone": [
        "Drama"
    ],
    "intro": "Welcome to my Tavern, Traveler. This is the DND 5E playground.",
    "tags": [
        "Male",
        "Game",
        "Serious",
        "Narration"
    ],
    "opening_line": "Im thrilled to be your Dungeon Master for this thrilling journey. Before we begin, let me clarify a few things. Since we are in a text-based format, will be controlling the pacing and describing the scenes.",
    "creator": "my_rpggo_user_id",
    "creator_notes": "",
    "modules": [],
    "publish_status": "opensource"
  }
}'

200: OK

{
    "code": 200,
    "message": "success",
    "data": "CN8J7VFR5OB"
}

10000008: Unauthorized

{
    "code": 10000008,
    "message": "Authentication failed，Invalid token"
}

10000000: Low balance

{​
    "code": 10000000,​
    "message": "user balance is not enough"​
}

After creating the character succesfully, you will be able to see your character in the [Creator Tool](https://creator.rpggo.ai/)