Conversations
Overview#
Use the Conversations API call to create and retrieve AI chat conversations. This REST API call allows you to do the following:
Using the namespace filter#
Note: The
nsfilter(namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace.
Example:
GET /aisvc/api/v1/conversations?nsfilter=your_namespace
Create Conversations#
Endpoint#
POST /aisvc/api/v1/conversationsRequest#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | Filter by namespace. | Required |
sync | Boolean | Perform synchronous/asynchronous conversation. | Optional |
Body parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
_input | Object | Input payload, with message field. | Required |
_teamId | String | ID of the team. | Required |
_id | String | ID of the conversation. | Conditional |
Note#
New conversation → Omit _id in req.body. Continue conversation → Set _id in req.body using the value returned in the previous response.
Body example#
{ "_input": { "message": "What is BIM?" }, "_namespaces": ["automation_XjAB8VEB"], "_teamId": "f73d1653-bf1d-4f00-ad58-543ac48f80a3"}
Response codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
Response#
{ "_id": "8f2dfd89-94f4-4fea-a1a1-d1c6dfdb90c3", "_output": "BIM = Building Information Modeling. At its simplest: BIM is a digital process that creates and uses a coordinated, information‑rich 3D model of a built asset (building, bridge, plant, etc.) to support design, construction and operation across the asset lifecycle.\n\nKey points in plain language\n- A BIM model is not just geometry — it combines 3D objects (walls, doors, beams) with structured data (material, size, cost, fire rating, maintenance schedules).\n- BIM is both a set of technologies (authoring tools, viewers, data exchange formats) and a collaborative working method and workflow (who creates what information, how it’s shared and updated).\n- The goal is better coordination, fewer errors, faster delivery and more useful information for facility operation.\n\nMain uses (often abbreviated as “dimensions”)\n- 3D: visualization and geometric coordination.\n- 4D: schedule/time simulations (construction sequencing).\n- 5D: cost estimating and budgeting.\n- 6D: lifecycle/operation data (asset management, sustainability).\n- Clash detection, quantity takeoffs, energy analysis, prefabrication planning, and handover documentation.\n\nStandards, data exchange and deliverables\n- Common formats: IFC (open standard from buildingSMART), RVT (Revit), DWG, COBie (handover asset data).\n- Common deliverables: federated coordination models, clash reports, quantities, drawing sets, schedules, and an asset information handover pack.\n- International standard: ISO 19650 series (information management using BIM) — widely used for defining responsibilities, common data environment (CDE) and workflows.\n\nRoles and tools\n- Typical roles: BIM Manager, BIM Coordinator, Model Author, CDE Administrator.\n- Popular authoring and collaboration tools: Autodesk Revit, Graphisoft Archicad, Tekla Structures, Bentley Systems, Solibri, Navisworks; cloud platforms include Autodesk Construction Cloud/BIM 360, Trimble Connect, Procore, etc.\n\nBIM maturity / levels\n- “BIM Level” terminology is used differently by region. Common UK concept: Level 0 (CAD), Level 1 (managed CAD), Level 2 (collaborative models with common data environment), Level 3 (fully integrated single models / digital twin).\n- Level of Development (LOD 100–500) describes how much detail and reliability objects in the model have.\n\nBenefits\n- Reduced conflicts and rework (clash detection before construction).\n- Faster, more accurate quantity takeoffs and cost control.\n- Improved coordination between disciplines (architectural/structural/M&E).\n- Better asset information for facility management and lifecycle decisions.\n- Enables prefabrication and offsite construction workflows.\n\nCommon challenges\n- Organizational change, skills gap and training needs.\n- Contractual and liability questions over shared models.\n- Interoperability issues (though IFC is improving this).\n- Upfront time/cost investment in setup, standards and CDE.\n\nIf you want, I can:\n- Give a short comparison of BIM vs CAD.\n- Explain ISO 19650 and what a Common Data Environment is.\n- Show a simple real-world BIM workflow for a small building project.\nWhich would be most useful for you?"}Get Conversations#
Endpoint#
GET /aisvc/api/v1/conversationsRequest#
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | Filter by namespace. | Required |
offset | Number | Offset for pagination. | Optional |
pagesize | Number | Number of results per page. | Optional |
Response codes#
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
Response data example#
{ "_list": [ { "_id": "88b906cb-aaac-458a-8e6a-b17feeb9cdbe", "_namespaces": [ "automation_XjAB8VEB" ], "_title": "What is BIM?", "_userId": "75957518-60e5-4a52-99cd-a9810fb067ff", "_status": 1, "_metadata": { "_createdAt": "1757657412279", "_updatedById": "75957518-60e5-4a52-99cd-a9810fb067ff", "_createdById": "75957518-60e5-4a52-99cd-a9810fb067ff", "_updatedAt": "1757657412279" } }, { "_id": "a9303794-ad67-43fd-abeb-9afa088fb6fb", "_namespaces": [ "automation_XjAB8VEB" ], "_title": "Get All assets.", "_userId": "1fa03865-9c89-4c37-a038-05514771dcf3", "_status": 1, "_metadata": { "_createdAt": "1757053798866", "_updatedById": "1fa03865-9c89-4c37-a038-05514771dcf3", "_createdById": "1fa03865-9c89-4c37-a038-05514771dcf3", "_updatedAt": "1757053806189" } } ], "_offset": 0, "_pageSize": 15, "_total": 15}Get Conversation by ID#
Endpoint#
GET /aisvc/api/v1/conversations/{id}Request#
Path parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
id | String | ID of the conversation. | Required |
Query parameters#
| Parameter | Type | Description | Required |
|---|---|---|---|
nsfilter | String | Filter by namespace. | Required |
getChats | Boolean | Include chat messages. | Optional |
firstN | Number | Number of messages from the start. | Optional |
lastN | Number | Number of messages from the end. | Optional |
textToMatch | String | Filter messages by vectorized text match. | Optional |
offset | Number | Offset for message pagination. | Optional |
Response codes#
| Code | Description |
|---|---|
200 | Success |
404 | Not Found |
Response data example#
{ "_id": "b268d1a3-97c6-4e57-ba8e-8272e72900e5", "_namespaces": [ "auto7470_qFcvagXr" ], "_title": "List all workspaces.", "_userId": "f5d6dcd2-582d-4383-b653-5c679ab8db3c", "_status": 1, "_metadata": { "_createdAt": "1757676118837", "_updatedById": "f5d6dcd2-582d-4383-b653-5c679ab8db3c", "_createdById": "f5d6dcd2-582d-4383-b653-5c679ab8db3c", "_updatedAt": "1757676233031" }, "_chats": [ { "_prompt": "List all workspaces.", "_llmResponse": "Here are all the workspaces:\n\n1. **Name:** automation1757676105957\n - **ID:** cedf0b81-fc02-40fb-b2aa-63144bd360fe\n - **Short Name:** auto_7470\n - **Description:** automation1757676105957\n\n2. **Name:** automation1757676112455\n - **ID:** 33788826-d660-4280-90f7-c683c9cc3480\n - **Short Name:** auto_1197\n - **Description:** automation1757676112455\n\n3. **Name:** automation1757676112455\n - **ID:** 7fee85c4-2c41-484f-9028-ccdfd0749791\n - **Short Name:** auto_3423\n - **Description:** automation1757676112455\n\n4. **Name:** automation1757676112455\n - **ID:** 4f669674-5ab5-453a-a6bc-683c40dd1be3\n - **Short Name:** auto_5606\n - **Description:** automation1757676112455\n\n5. **Name:** automation1757676112455\n - **ID:** b0cdac99-77bd-40c2-8646-84dbd984c366\n - **Short Name:** auto_7925\n - **Description:** automation1757676112455\n\n6. **Name:** automation1757676112455\n - **ID:** 1e125199-8210-4123-ab29-cea6384e1b12\n - **Short Name:** auto_8213\n - **Description:** automation1757676112455\n\nIf you need more details about any specific workspace, feel free to ask!" } ]}