Skip to main content
POST
/
api
/
agents
/
{agentId}
/
rooms
Create a room
curl --request POST \
  --url http://localhost:3000/api/agents/{agentId}/rooms \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roomId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "source": "<string>",
    "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entities": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}

Path Parameters

​
agentId
string<uuid>
required

ID of the agent

Body

application/json
​
name
string

Name of the room

​
worldId
string<uuid>

ID of the world

​
roomId
string<uuid>

Optional custom room ID

​
entityId
string<uuid>

Entity ID to add to the room

Response

Room created successfully

​
success
boolean
Example:

true

​
data
object