Prediction

Create a new prediction

post

Create a new prediction

Authorizations

Path parameters

idstringrequired

Chatflow ID

Body

application/jsonmultipart/form-data

questionstringoptional

The question being asked

overrideConfigobjectoptional

The configuration to override the default prediction settings (optional)

historyobject[]optional

The history messages to be prepended (optional)

uploadsobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/prediction/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "question": "text",
    "overrideConfig": {},
    "history": [
      {
        "role": "apiMessage",
        "content": "Hello, how can I help you?"
      }
    ],
    "uploads": [
      {
        "type": "file",
        "name": "image.png",
        "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAABjElEQVRIS+2Vv0oDQRDG",
        "mime": "image/png"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

404

422

500

200

{
  "text": "text",
  "json": {},
  "question": "text",
  "chatId": "text",
  "chatMessageId": "text",
  "sessionId": "text",
  "memoryType": "text",
  "sourceDocuments": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ],
  "usedTools": [
    {
      "tool": "Name of the tool",
      "toolInput": {
        "input": "search query"
      },
      "toolOutput": "text"
    }
  ],
  "fileAnnotations": [
    {
      "filePath": "path/to/file",
      "fileName": "file.txt"
    }
  ]
}

Prediction created successfully