API V2 (New)

Fetch Game, Set Control, Integrate Characters, Chat in SSE, Manage User Goal Check with AI Released on May 11, 2024.

Part 1. Data Schema

๐Ÿ”ขUnderstand the data schema

If you've read Understand the data schema already, in V2 API, we renamed "Scene" to "Chapter", and "NPC" to "Character".

Part 2. Game Control - Manage the User Experience in Game

  • Get Game Data

  • Start Game

  • Switch Chapters

  • Continue Sessions (Game progress memory)

Game Control

Part 3. Chat with NPCs & Check Goal with SSE - What's in SSE

  • Chat with NPCs in SSE (single chat, group chat)

  • Normal NPC Conversations

  • Game Control Messages AI Powered Goal Check

Chat with NPCs & Check Goal with SSE
  • Async via SSE: V1 provides synced api call only. But V2, we turn to async msg push, which means all the generation will be pushed to client via SSE.

Part 4. Multi-modal Output

Part 5. Game List Authorization

  • You can only access permission-granted games.

  • Let us know if you are interested in any GameId or a GameId list. send request to [email protected]

Part 6. Sample Code

Last updated

Was this helpful?