Skip to main content
POST
/
api
/
knowledge
/
documents
/
stream
curl -X POST https://api.example.com/api/knowledge/documents/stream \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -N \
  -d '{
    "projectId": "proj_123",
    "fileName": "large-document.pdf",
    "fileType": "pdf",
    "sourceType": "upload",
    "content": "Large document content..."
  }'
data: {"type":"progress","progress":10,"message":"Parsing document"}

data: {"type":"progress","progress":30,"message":"Extracting text"}

data: {"type":"progress","progress":60,"message":"Creating embeddings"}

data: {"type":"progress","progress":90,"message":"Storing vectors"}

data: {"type":"complete","progress":100,"message":"Document indexed successfully","documentId":"doc_abc123xyz"}

Request Body

projectId
string
required
Project ID to associate the document with
fileName
string
required
Name of the file/document
fileType
string
required
Type of file (e.g., pdf, txt, md, docx)
sourceType
string
required
Source type of the document (e.g., upload, url, integration)
content
string
required
Content of the document to be indexed
fileId
string
Optional file ID if document is linked to a file

Response

This endpoint returns a Server-Sent Events (SSE) stream with real-time progress updates.
type
string
Event type (e.g., progress, complete, error)
progress
number
Progress percentage (0-100)
message
string
Current status message
curl -X POST https://api.example.com/api/knowledge/documents/stream \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -N \
  -d '{
    "projectId": "proj_123",
    "fileName": "large-document.pdf",
    "fileType": "pdf",
    "sourceType": "upload",
    "content": "Large document content..."
  }'
data: {"type":"progress","progress":10,"message":"Parsing document"}

data: {"type":"progress","progress":30,"message":"Extracting text"}

data: {"type":"progress","progress":60,"message":"Creating embeddings"}

data: {"type":"progress","progress":90,"message":"Storing vectors"}

data: {"type":"complete","progress":100,"message":"Document indexed successfully","documentId":"doc_abc123xyz"}