Skip to main content
PATCH
/
context
/
world
/
{game_id}
/
{world_id}
Update world details
curl --request PATCH \
  --url https://app.npcbuilder.com/api/context/world/{game_id}/{world_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lore": "A world where magic and technology coexist.",
  "name": "Eldoria",
  "creatures": "Dragons, Elves",
  "similarWorlds": [
    "Middle Earth"
  ]
}
'
{
  "message": "World: world456 has been updated with the following context.",
  "world_id": "world456",
  "world_context": {
    "lore": "A world where magic and technology coexist.",
    "name": "Eldoria",
    "creatures": "Dragons, Elves",
    "similarWorlds": [
      "Middle Earth"
    ]
  }
}

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"

Body

application/json

The world data fields to update.

​
lore
string

Updated background lore of the world.

Example:

"A world where magic and technology coexist."

​
name
string

Updated name of the world.

Example:

"Eldoria"

​
creatures
string

Updated list of creatures.

Example:

"Dragons, Elves"

​
similarWorlds
string[]

Updated list of similar worlds.

Response

World updated successfully.

​
message
string

Confirmation message after updating the world.

Example:

"World: world456 has been updated with the following context."

​
world_id
string

UID of the world.

Example:

"world456"

​
world_context
object

The context details of the created world.

Example:
{
  "lore": "A world where magic and technology coexist.",
  "name": "Eldoria",
  "creatures": "Dragons, Elves",
  "similarWorlds": ["Middle Earth"]
}