Update a world

Update world properties

PATCH /api/agents/{agentId}/worlds/{worldId}

Update a world

cURL

curl --request PATCH \
  --url http://localhost:3000/api/agents/{agentId}/worlds/{worldId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "metadata": {}
}
'

200

{
  "success": true,
  "data": {
    "world": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sourceType": "<string>",
      "sourceId": "<string>",
      "metadata": {}
    }
  }
}

Path Parameters

agentId · string<uuid> · required

ID of the agent

worldId · string<uuid> · required

ID of the world to update

Body

application/json

name · string

Updated name for the world

metadata · object

Updated metadata (merged with existing)

Response

200

application/json

World updated successfully

success · boolean

Example:

true

data · object

Show child attributes