Upload

Upload content (files, URLs, or text) to a collection.

Args:

collection_id (str): Required. ID of the collection to upload to.

file (UploadFile, optional): Single file to upload.

files (List[UploadFile], optional): Multiple files to upload.

content (str, optional): Direct text content to upload.

urls (List[str], optional): List of URLs to download and upload.

content_type (str, optional): Type of content - ‘file’, ‘url’, or ‘text’. Default: ‘file’.

metadata (Dict[str, Any], optional): Additional metadata to attach to uploaded content.

label (str, optional): Custom label for the content. description (str, optional): Description of the content. crawl (bool, optional): Whether to crawl linked content from URLs. Default: False. ingest (bool, optional): Whether to ingest content into vector database. Default: True. If False, only file metadata is stored. Use POST /v1/chunks/create to ingest later. reader (str, optional): Reader to use for processing files. Default: ‘native’.

Reader Parameter: Controls how uploaded files are processed. Supported formats:

Provider Format:

• ‘native’: Use native implementation (default, fastest)
• ‘langchain’: Use LangChain readers for all files
• ‘markitdown’: Use MarkItDown for universal conversion to markdown

Provider + Type Format:

• ‘langchain_pdfplumber’: LangChain with PDFPlumber (better OCR, tables)
• ‘langchain_pypdf’: LangChain with PyPDF (faster for text-based PDFs)

Specific Reader:

• ‘pdf’, ‘csv’, ‘docx’, ‘json’, ‘markdown’, ‘text’

Returns: UploadResponse: Contains upload status, successful uploads, and any errors.

• collection_id: ID of the collection
• content_type: Type of content uploaded
• uploads: List of successfully uploaded content
• errors: List of failed uploads with error details
• total_uploads: Total number attempted
• successful_uploads: Number successful
• failed_uploads: Number failed

Examples: Upload a single file with native reader: POST /upload Form data:

• file: document.pdf
• collection_id: “my_docs”
• reader: “native”

Upload PowerPoint with MarkItDown (converts to markdown): POST /upload Form data:

• file: presentation.pptx
• collection_id: “presentations”
• reader: “markitdown”

Upload scanned PDF with better OCR: POST /upload Form data:

• file: scanned.pdf
• collection_id: “scans”
• reader: “langchain_pdfplumber”

Upload from URLs: POST /upload Form data:

• urls: [“https://example.com/doc1.pdf”, “https://example.com/doc2.pdf”]
• collection_id: “web_docs”
• content_type: “url”

Upload direct text content: POST /upload Form data:

• content: “This is my text content”
• collection_id: “notes”
• content_type: “text”
• label: “Quick Note”

Upload file without ingesting (metadata only): POST /upload Form data:

• file: document.pdf
• collection_id: “pending_docs”
• ingest: false Note: Use POST /v1/chunks/create later to ingest content

Raises: HTTPException: 403 if collection not accessible

HTTPException: 400 if invalid parameters

HTTPException: 500 if upload processing fails

POST /api/v1/upload

Upload

cURL

curl --request POST \
  --url https://api.example.com/api/v1/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'collection_id=<string>' \
  --form 'file=<string>' \
  --form 'files=<string>' \
  --form 'content=<string>' \
  --form 'urls=<string>' \
  --form content_type=file \
  --form 'metadata=<string>' \
  --form 'user_id=<string>' \
  --form 'label=<string>' \
  --form 'description=<string>' \
  --form crawl=false \
  --form ingest=true \
  --form 'reader=<string>' \
  --form file.0='@example-file' \
  --form files.0.items='@example-file'

import requests

url = "https://api.example.com/api/v1/upload"

files = {
    "file.0": ("example-file", open("example-file", "rb")),
    "files.0.items": ("example-file", open("example-file", "rb"))
}
payload = {
    "collection_id": "<string>",
    "file": "<string>",
    "files": "<string>",
    "content": "<string>",
    "urls": "<string>",
    "content_type": "file",
    "metadata": "<string>",
    "user_id": "<string>",
    "label": "<string>",
    "description": "<string>",
    "crawl": "false",
    "ingest": "true",
    "reader": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('collection_id', '<string>');
form.append('file', '<string>');
form.append('files', '<string>');
form.append('content', '<string>');
form.append('urls', '<string>');
form.append('content_type', 'file');
form.append('metadata', '<string>');
form.append('user_id', '<string>');
form.append('label', '<string>');
form.append('description', '<string>');
form.append('crawl', 'false');
form.append('ingest', 'true');
form.append('reader', '<string>');
form.append('file.0', '{
  "fileName": "example-file"
}');
form.append('files.0.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.example.com/api/v1/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\nfile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"crawl\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ingest\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reader\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\nfile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"crawl\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ingest\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reader\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/upload")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\nfile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"crawl\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ingest\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reader\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urls\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"content_type\"\r\n\r\nfile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"label\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"crawl\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ingest\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reader\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Body

multipart/form-data

collection_id · string · required

file · file | null

files · file[] | null

content · string | null

urls · string[] | null

content_type · string | null · default: file

metadata · string | null

user_id · string | null

label · string | null

description · string | null

crawl · boolean | null · default: false

ingest · boolean | null · default: true

reader · string | null

Reader to use for processing files. Supported values:
    - 'native': Use native implementation (default)
    - 'langchain': Use LangChain readers for all files
    - 'markitdown': Use MarkItDown for universal conversion to markdown
    
    Provider + Type Format:
        - 'langchain_pdfplumber': LangChain with PDFPlumber (better OCR, tables)
        - 'langchain_pypdf': LangChain with PyPDF (faster for text-based PDFs)
    
    Specific Reader:
        - 'pdf', 'csv', 'docx', 'json', 'markdown', 'text'

Response

200

application/json

Successful Response