Skip to main content
PATCH
/
api
/
agents
/
{agentId}
/
worlds
/
{worldId}
Update a world
curl --request PATCH \
  --url http://localhost:3000/api/agents/{agentId}/worlds/{worldId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "metadata": {}
}
'
import requests

url = "http://localhost:3000/api/agents/{agentId}/worlds/{worldId}"

payload = {
    "name": "<string>",
    "metadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', metadata: {}})
};

fetch('http://localhost:3000/api/agents/{agentId}/worlds/{worldId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/agents/{agentId}/worlds/{worldId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/agents/{agentId}/worlds/{worldId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("http://localhost:3000/api/agents/{agentId}/worlds/{worldId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/agents/{agentId}/worlds/{worldId}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "world": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sourceType": "<string>",
      "sourceId": "<string>",
      "metadata": {}
    }
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

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

World updated successfully

​
success
boolean
Example:

true

​
data
object