Upload a Document to a Corpus

Enables authorized users to upload a new document into a specific corpus by providing essential details via a multipart/form-data request.

Purpose:

Designed for adding new content to an existing corpus for indexing, searching, or analysis purposes.

Ensures each document is properly linked with a corpus and can be processed asynchronously.

Request Body Parameters (form-data):

content_type (str, required): Specifies the type of content being uploaded. Must be one of: 'file', 'text', or 'weblink'.

source (str or file, required): The content itself — either a text string, a URL, or a file (e.g., PDF, DOCX, TXT).

upload_from (str, optional): Indicates the origin of the upload (e.g., 'web').

user_id (int, required): ID of the user performing the upload.

Supported Upload Types:

File Upload

Uploads supported document files, including:
PDF, Word, Excel, CSV, PPTX, RTF, EML, EPUB, XML, KML, GZ, JSON, Text, HTML, ZIP, Open Document formats.

content_type: 'file'

source: File to upload (e.g., sample.pdf, report.docx, data.xlsx)

Text Upload

Uploads plain text input.

content_type: 'text'

source: Any text string (e.g., "I am learning...")

Weblink Upload

Uploads a URL pointing to an online webpage or document.

content_type: 'weblink'

source: Valid URL (e.g., https://example.com/doc.pdf)

Returns

A JSON Response containing the uploaded document data

Current Version:

2.0.0

curl --location --globoff 'https:///indexing-service/api/v2/corpora//documents' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer ' \ --form 'user_id="user123"' \ --form 'content_type="file"' \ --form 'source=@""' \ --form 'upload_from="web"' \ --form 'access_url="https://example.com/document.pdf"' \ --form 'data_id="123"' \ --form 'tags="tag1"' \ --form 'tags="tag2"' \ --form 'step="pending"' \ --form 'refresh="false"' \ --form 'etag="d41d8cd98f00b204e9800998ecf8427e"' \ --form 'sitemap_id="123"'

{ "success": true, "message": "Document has been queued for indexing", "data": { "id": 123, "source": "document.pdf", "access_url": "https://storage.example.com/document.pdf", "step": "pending" } }

Upload a Document to a Corpus

Request

Responses