RPGGO Developer Documentation
  • Introduction
    • ๐ŸŽฎRPGGO API: the AI Engine for Game
    • ๐Ÿ˜ŽGetting Started
  • DATA SCHEMA
    • ๐Ÿ”ขUnderstand the data schema
    • ๐ŸชฟLLM-based Game Open Schema (L-GOS)
  • CREATOR API
    • ๐Ÿ†•V2 API
      • Create Character
      • Create Game SpriteSheet
  • Player API
    • โš™๏ธAPI Overview
      • API V2 (New)
        • Game Control
        • Chat with NPCs & Check Goal with SSE
      • API V1 (Deprecated)
        • Game
        • NPC
        • Memory
        • ErrorCode
    • ๐Ÿ“ฐNotes: API V2 Released
      • Changes
  • Open Source Use Cases
    • ๐ŸŽStep by Step: Discord with V1 API
    • ๐Ÿ’Simple Chat Game with V2 API
    • ๐Ÿฐ2D AI Town with V2 API
    • ๐ŸŒดStardew Valley Mod with V2 API
    • ๐ŸŒAI Game Website with V2 API
  • Thesis
    • ๐Ÿ—’๏ธThesis 2024: A Text-to-Game Engine for UGC-Based Role-Playing Games
    • ๐Ÿ—’๏ธInitial Vision 2023: Text-To-OpenWorld Engine
  • Support
    • ๐Ÿ”‘Apply Your Test Key
    • ๐Ÿ“ฉContact us
Powered by GitBook
On this page

Was this helpful?

  1. CREATOR API
  2. V2 API

Create Character

Creating a minimalist Solo-Character.

PreviousV2 APINextCreate Game SpriteSheet

Last updated 3 months ago

Was this helpful?

1. Create a character with L-GOS schema

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

POST

Request Body

same as

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"]

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"
  }
}'
{
    "code": 200,
    "message": "success",
    "data": "CN8J7VFR5OB"
}

{
    "code": 10000008,
    "message": "Authentication failed๏ผŒInvalid token"
}

{โ€‹
    "code": 10000000,โ€‹
    "message": "user balance is not enough"โ€‹
}

See the tags definitions here: [L-GOS Tags]() Just fill in the value under the specific type, case-insensitive Only one value can be selected for each type

After creating the character succesfully, you will be able to see your character in the [Creator Tool]()

๐Ÿ†•
https://api.rpggo.ai/v2/character/create
https://github.com/RPGGO-AI/l-gos-spec/blob/main/schema_v1/character_v1.md
https://creator.rpggo.ai/
https://github.com/RPGGO-AI/l-gos-spec/blob/main/schema_v1/tag_v1.md