Skip to main content
GET
/
context
/
location
/
{game_id}
/
{world_id}
/
{location_id}
Get location details
curl --request GET \
  --url https://app.npcbuilder.com/api/context/location/{game_id}/{world_id}/{location_id} \
  --header 'Authorization: Bearer <token>'
{
  "location_id": "location789",
  "location": {
    "id": "location789",
    "name": "Rivertown",
    "lore": "A bustling market town.",
    "role": "Trade hub",
    "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"

location_id
string
required

The unique identifier for the location.

Example:

"location789"

Query Parameters

session_id
string

(Optional) The player's session ID.

Example:

"60Z5aZjIuFlyYbjbZZKe"

Response

Location retrieved successfully.

location_id
string

UID of the location.

Example:

"location789"

location
object