Document

Deprecated

Add Documents to Vector Store

post

🚨 DEPRECATED ENDPOINT 🚨

This endpoint is deprecated and will be removed in a future version. Please migrate to /documents immediately.

---

Process multiple documents and add them to the vector store. Supports both file uploads and URLs.

⚠️ IMPORTANT REQUIREMENT: Files must be uploaded in the exact same order as the FILE-type entries in your file_metadatas array. Filename validation is enforced.

Body

multipart/form-data

conversation_idany ofOptional

The conversation ID.

stringOptional

or

nullOptional

file_metadatasstring[]Required

List of file metadatas in JSON string format. Examples:

• For file upload: {"file_id":"123456","input_type":"FILE","filename":"file.pdf"}
• For URL: {"file_id":"123456","input_type":"URL","url":"https://example.com/file"}

knowledge_base_idstringRequired

The knowledge base ID.

filesstring · binary[]Optional

List of files to be uploaded.

Default: []

Responses

200

Successful Response

application/json

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/add-documents

HTTPcURLJavaScriptPython

POST /add-documents HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 98

{
  "conversation_id": "text",
  "file_metadatas": [
    "text"
  ],
  "knowledge_base_id": "text",
  "files": [
    "binary"
  ]
}

{
  "message": "Files have been added successfully."
}

Add Documents to Vector Store

post

Process multiple documents and add them to the vector store. Supports both file uploads and URLs.

⚠️ IMPORTANT REQUIREMENT: Files must be uploaded in the exact same order as the FILE-type entries in your file_metadatas array. Filename validation is enforced.

Body

multipart/form-data

conversation_idany ofOptional

The conversation ID.

stringOptional

or

nullOptional

file_metadatasstring[]Required

List of file metadatas in JSON string format. Examples:

• For file upload: {"file_id":"123456","input_type":"FILE","filename":"file.pdf"}
• For URL: {"file_id":"123456","input_type":"URL","url":"https://example.com/file"}

knowledge_base_idstringRequired

The knowledge base ID.

filesstring · binary[]Optional

List of files to be uploaded.

Default: []

Responses

200

Successful Response

application/json

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/documents

HTTPcURLJavaScriptPython

POST /documents HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 98

{
  "conversation_id": "text",
  "file_metadatas": [
    "text"
  ],
  "knowledge_base_id": "text",
  "files": [
    "binary"
  ]
}

{
  "message": "Files have been added successfully."
}