Create a room

Create a new room for an agent

POST /api/memory/{agentId}/rooms

Create a room

cURL

curl --request POST \
  --url http://localhost:3000/api/memory/{agentId}/rooms \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "DM",
  "source": "client",
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serverId": "<string>",
  "metadata": {}
}
'

import requests

url = "http://localhost:3000/api/memory/{agentId}/rooms"

payload = {
    "name": "<string>",
    "type": "DM",
    "source": "client",
    "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serverId": "<string>",
    "metadata": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    type: 'DM',
    source: 'client',
    worldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    serverId: '<string>',
    metadata: {}
  })
};

fetch('http://localhost:3000/api/memory/{agentId}/rooms', 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/memory/{agentId}/rooms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'type' => 'DM',
    'source' => 'client',
    'worldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'serverId' => '<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/memory/{agentId}/rooms"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"DM\",\n  \"source\": \"client\",\n  \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serverId\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("http://localhost:3000/api/memory/{agentId}/rooms")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": \"DM\",\n  \"source\": \"client\",\n  \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serverId\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/memory/{agentId}/rooms")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"type\": \"DM\",\n  \"source\": \"client\",\n  \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serverId\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

201

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": 123,
    "source": "<string>",
    "type": "<string>",
    "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serverId": "<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

Body

application/json

name · string · required

Name of the room

type · enum<string> · default: DM

Type of room

Available options: DM, GROUP, CHANNEL

source · string · default: client

Source of the room

worldId · string<uuid>

ID of the world

serverId · string

Server ID

metadata · object

Additional room metadata

Response

201

application/json

Room created successfully

success · boolean

Example:

true

data · object

Show child attributes