Get started
Request a Demo
Get started

Streamlining character creation with Studio REST API

Sherrie Cao
December 14, 2023
Related posts
Want to try Inworld?
Get started

In game creation, studios prioritize maximizing efficiency in development time to streamline workflows and simplify creativity. Our goal with our new Studio REST API release is to reduce friction for game developers with a robust and flexible tool that mirrors the functionality of our Inworld Studio and creates a time-saving short-cut for custom character creation. Studio REST API enables developers to leverage their existing tools for asset creation and management, introducing a simple and efficient way to use Inworld’s Studio functionalities. 

At design time

Studio REST API empowers game developers to build characters on the client side through programmatic character creation and moderation. This text-based method of character creation facilitates better version control and accelerates character iteration with rapid testing of designs. 

Developers can generate character profiles on the client side and use the API to make requests to the Inworld AI server from any development environment. This facilitates batch imports, updates, or deletions of multiple assets simultaneously. The process automates the updating of character core descriptions, knowledge, common knowledge, and more, while also creating workspaces for each player automatically.

At runtime

Studio REST API also enables players, or end users, to create custom characters as user-generated content during gameplay. Players can customize the personalities, behavior, and dialogue of their own AI NPCs (non-playable characters). In a fantasy role-playing game, players could design AI companions with specialized knowledge to assist them in their quests. Or, in a city-building simulation, players could shape the dynamics and narrative of their virtual cities with unique AI citizens. 

This API gives creators an easy-to-use tool to empower their players to contribute to the game world in a unique and creative way, fostering deeper immersion and engagement.

Get started today

See our documentation to get started with Studio REST API today!

base_url = 'https://api.inworld.ai/studio/v1'

def create_character_example():
    create_character_json = """
    "default_character_description": {
        "character_role": "Warrior",
        "description": "Likes to fight in hard battles with a huge axe.",
        "given_name": "Axeon the Enchanted"
    },
    "language_code": "en-us"
}
"""
    char_dict = json.loads(create_character_json)
    headers = {
        'Content-Type': 'application/json',
        'Grpc-Metadata-X-Authorization-Bearer-Type': 'studio_api'
    }
    # assuming we have a workspace called magic-world
    response = requests.post(
        url=f"{base_url}/workspaces/magic-world/characters",
        json=char_dict,
        headers=headers
        , auth=HTTPBasicAuth(api_key, api_secret)
    )
    # this will create character based on given name "Axeon the Enchanted" => workspaces/magic-world/characters/axeon_the_enchanted

Stay connected

Get the latest updates, events, and offers from Inworld.