🧙‍♂️🌟 GPT Legends | persistent text RPG game 🔮 · GPT-Aktionen

{
  "openapi": "3.1.0",
  "info": {
    "title": "GPT Legends Game",
    "description": "Interact with the world of GPT Legends",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://api.gptlegends.ai"
    }
  ],
  "components": {
    "schemas": {},
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2"
      }
    }
  },
  "paths": {
    "/game/get_status": {
      "get": {
        "description": "Get the current description and status of your character, including its most recent actions and any pending ones",
        "operationId": "GetCharacter",
        "parameters": [],
        "deprecated": false,
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    },
    "/game/create_character": {
      "post": {
        "description": "Create the player's character",
        "operationId": "CreateCharacter",
        "security": [
          {
            "oauth2": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The name of the character to be created"
                  },
                  "description": {
                    "type": "string",
                    "description": "The description of the character to be created"
                  }
                },
                "required": [
                  "name",
                  "description"
                ]
              }
            }
          }
        }
      }
    },
    "/game/location_info": {
      "post": {
        "description": "Get information about a specific location including a description, notable npc and a list of quests/jobs",
        "operationId": "GetLocationInfo",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "location_id": {
                    "type": "string",
                    "description": "The ID of the destination location"
                  }
                },
                "required": [
                  "location_id"
                ]
              }
            }
          }
        },
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    },
    "/game/dynamic_quest_finished": {
      "post": {
        "description": "Call this when you have guided the player through a quest. Pass in a short summary of their accomplishments, and the reward they shall be given.",
        "operationId": "DynamicQuestFinished",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "quest_type": {
                    "type": "string",
                    "description": "The type of the quest (e.g. fetch, investigate, any others)"
                  },
                  "quest_summary": {
                    "type": "string",
                    "description": "A summary of the quest and the player's performance. Must be shorter than 1000 characters"
                  },
                  "gold_reward": {
                    "type": "integer",
                    "description": "The amount of gold to reward the player. Must be an integer between 1 and 20",
                    "minimum": 1,
                    "maximum": 20
                  }
                },
                "required": [
                  "quest_type",
                  "quest_summary",
                  "gold_reward"
                ]
              }
            }
          }
        },
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    },
    "/game/travel_start": {
      "post": {
        "description": "Start traveling to a new location",
        "operationId": "StartTravel",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "destination_location_id": {
                    "type": "string",
                    "description": "The ID of the destination location"
                  }
                },
                "required": [
                  "destination_location_id"
                ]
              }
            }
          }
        },
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    },
    "/game/nearby-players": {
      "get": {
        "description": "Get information about players nearby on the same location",
        "operationId": "GetNearbyPlayersInfo",
        "parameters": [],
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    },
    "/game/compact_leaderboard": {
      "get": {
        "description": "Get the top 10 players with the most gold + the rank of the current player. Always display it as a markdown table, bold the current player row.",
        "operationId": "GetLeaderboard",
        "parameters": [],
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    }
  }
}