Skip to main content
GET
/
room
/
:room_id
/
uml
Get Room UML
curl --request GET \
  --url https://api.example.com/room/:room_id/uml \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_private": true
}
'
{
  "content": [
    {}
  ]
}
Retrieves the UML (Unified Modeling Language) diagram data for all documents in a room.

​
Authentication

Required for private rooms. Use the Authorization header with a bearer token.

​
Path Parameters

​
room_id
string
required
The unique identifier of the room.

​
Body Parameters

​
is_private
boolean
default:false
Indicates whether the room is private. Private rooms require authentication.

​
Headers

​
Authorization
string
Bearer token for authentication. Required if is_private is true.

​
Response

​
content
array
Array containing the UML diagram data for the room’s documents.

​
Error Responses

  • 401 - Unauthorized user (missing token for private room).
  • 403 - Invalid token (user is not the room creator for private room).
  • 500 - Error extracting UML data.

​
Example Request

curl -X GET \
  https://api.planttogether.com/room/abc123/uml \
  -H "Content-Type: application/json" \
  -d '{
    "is_private": false
  }'

​
Example Response

[
  {
    "documentId": "doc123",
    "documentName": "my-document",
    "umlData": "..."
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us