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
  • Get your API key
  • Use API key to authenticate

Was this helpful?

  1. Support

Apply Your Test Key

What you need to make your game link into RPGGO's API...

Last updated 24 days ago

Was this helpful?

  • RPGGO Public API is in currently under alpha phase and do not open to auto-public application.

  • If you want to try it for personal demo, following below instruction to self-service your API key, but those of keys have rate limit.

  • If you need a key for a commercial use case(without rate limit), please submit an application form via here, or send an email to dev@rpggo.ai to get an prod API key

Get your API key

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

The good news is, we are currently openning the api key management for everyone. You can

  1. go to https://rpggo.ai/

  2. Log in with your Google or Discord account. Click your avatar in the up-right corner and find the "Manage Your API Key" in the submenu. Copy the API key.

Use API key to authenticate

For users who create multiple apps, you should pass a header to specify which App is used for an API request. Future usage from these API requests will count against the specified App's subscription quota.

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

All API requests should include API key in HTTP header as follows:

Authorization: Bearer YOUR_RPGGO_API_KEY

Example curl command:

curl https://api.rpggo.ai/open/game/gamelist \
  -H "Authorization: Bearer $YOUR_RPGGO_API_KEY"

RPGGO server will verify permissions by the Authorization and several other parameters. If an incorrect key is used the API will return a 401 HTTP error.

🔑