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
  • 1. Endpoint
  • 2. Request Body
  • Rate Limits

Was this helpful?

  1. CREATOR API
  2. V2 API

Create Game SpriteSheet

Creating a 2D pixel art for your game.

PreviousCreate CharacterNextAPI Overview

Last updated 3 months ago

Was this helpful?

The SpriteSheet Generation API allows developers to generate AI-powered 2D pixel-style spritesheets for use in game engines. By providing a textual prompt, the API will return a spritesheet in the requested style and format.

Super Mario, Sheet
Super Mario, gif

1. Endpoint

POST https://api.rpggo.ai/v2/assets/spritesheet/create

2. Request Body

Name
Type
Example Value
Description

style

String

"v1"

Two versions available ["v1", "v2"]. Default is v1.

form

String

"sheet"

Tow formats available ["sheet", "gif"]. Default is "sheet", for game engine use case. "gif" is more suitable for profile, avatar needs.

prompt

String

"Super Mario in snow cloth"

Describe the appearance of the sprite sheet. Default is "", which means for a random generation.

scale_by

int

2

tile size of the sprite sheet. Default is 2.

Note, you need to fill in your own api key in the curl. For how to apply api key, Apply Your Test Key

Sample Curl
curl --location 'https://api.rpggo.ai/v2/assets/spritesheet/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: YOUR-API-KEY' \
--data '{
    "style": "v1",
    "prompt": "a girl",
    "form": "sheet",
    "scale_by": 2
}'
{
    "code": 200,
    "msg": "ok",
    "data": {
        "img_url": "https://storage.googleapis.com/rpggo-imagegen/CHARACTER_SHEET/54d9b5f8d25d4a1991eb2d2f26cdaa3f.gif"
    }
}

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

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

Rate Limits

  • each api call will spend 30 GG coins. Make sure you have balance in your account.

Pikachu, gif
๐Ÿ†•