Prediction
POST
/prediction/{id}
Create a new prediction
Create a new prediction
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Chatflow ID</td></tr></tbody></table></div>
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">question</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The question being asked</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">overrideConfig</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The configuration to override the default prediction settings (optional)</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">history</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The history messages to be prepended (optional)</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">uploads</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Prediction created successfully</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">text</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The result of the prediction</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">json</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The result of the prediction in JSON format if available</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">question</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The question asked during the prediction process</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The chat ID associated with the prediction</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatMessageId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The chat message ID associated with the prediction</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">sessionId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The session ID associated with the prediction</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">memoryType</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">The memory type associated with the prediction</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">sourceDocuments</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">usedTools</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">fileAnnotations</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid input provided</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Chatflow not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">422</span>
<span class="api-response-desc">Validation error</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>