Update API doc to mention isSync flag when posting conversation or me…

…ssage (#4566)
dust-tt · Apr 4, 2024 · 1179bca · 1179bca
1 parent 3ef4baf
commit 1179bca
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/src/pages/conversations.mdx b/docs/src/pages/conversations.mdx
@@ -340,6 +340,10 @@ The `agent_error` event is sent whenever an error occured durint the AgentMessag
         An initial user message object. See "Create a New User Message" endpoint body attributes for
         more details.
       </Property>
+      <Property name="isSync" type="boolean">
+        When set to true, the conversation will be created synchronously and the response will
+        include the full generation data. Default value is false.
+      </Property>
     </Properties>
 
   </Col>
@@ -468,6 +472,15 @@ The `agent_error` event is sent whenever an error occured durint the AgentMessag
       </Property>
     </Properties>
 
+    ### Optional JSON body attributes
+
+    <Properties>
+      <Property name="isSync" type="boolean">
+        When set to true, the message will be posted synchronously and the response will
+        include agentMessages. Default value is false.
+      </Property>
+    </Properties>
+
   </Col>
   <Col sticky>