Skip to main content
GET
/
context
/
world
/
{game_id}
/
{world_id}
Get world details
curl --request GET \
  --url https://app.npcbuilder.com/api/context/world/{game_id}/{world_id} \
  --header 'Authorization: Bearer <token>'
{
  "world_id": "world456",
  "world": {
    "id": "world456",
    "name": "Eldoria",
    "lore": "A world where magic and technology coexist.",
    "description": "A bright high-fantasy world.",
    "creatures": "Dragons, Elves",
    "similarWorlds": [
      "Middle Earth"
    ],
    "characters": [
      {
        "id": "character789",
        "name": "Aragorn",
        "role": "protagonist"
      }
    ],
    "locations": [
      {
        "id": "location789",
        "name": "Rivertown",
        "role": "Trade hub",
        "characters": [
          {
            "id": "character789",
            "name": "Aragorn",
            "role": "protagonist"
          }
        ]
      }
    ],
    "regions": [
      {
        "id": "region789",
        "name": "Mystic Forest",
        "locations": [
          {
            "id": "location789",
            "name": "Rivertown",
            "role": "Trade hub",
            "characters": [
              {
                "id": "character789",
                "name": "Aragorn",
                "role": "protagonist"
              }
            ]
          }
        ],
        "characters": [
          {
            "id": "character789",
            "name": "Aragorn",
            "role": "protagonist"
          }
        ]
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.npcbuilder.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

game_id
string
required

The unique identifier for the game.

Example:

"game123"

world_id
string
required

The unique identifier for the world.

Example:

"world456"

Query Parameters

session_id
string

(Optional) The player's session ID.

Example:

"60Z5aZjIuFlyYbjbZZKe"

Response

World retrieved successfully.

world_id
string

UID of the world.

Example:

"world456"

world
object