Adds a document to a given collection.

A status code of `201 Created` will be returned if a document was successfully added. A status code of `409 Conflict` will be returned if the given collection already has a document with the same path.

If `overwrite` is given a value of `true`, then a status code of `200 OK` will be returned if a document was overwritten (Rather than a status code of `409 Conflict`).

When a document is inserted, it can take time to appear in the index. Check the `/status/get-status` endpoint to see progress.

Add Document

The file's raw data, as a base64-encoded string

Base64 Data

When this is set to `auto`, then the file extension and binary data will be used to deduce a filetype automatically. Currently, only `auto` is supported.

Type

APIBinaryDocument

The content of this document, as a text string

Text

APITextDocument

The content of this document, as an array of strings. Each string will be the content of a full page, and can be retrieved using the Top Pages endpoint. Pages are 0-indexed, so that the first string has index 0, the second string has index 1.

Pages

APITextPagesDocument

Location

Message

Error Type

ValidationError

AddDocumentRequest

HTTPBearer

DefaultResponse

HTTPValidationError

ZeroEntropy

Welcome to the ZeroEntropy documentation.

Introduction

Understand the core concepts of the ZeroEntropy API.

Core Concepts

Getting Started using the ZeroEntropy API

Quickstart

Metadata Filtering

Architecture

Creates or updates an organization with the provided organization name. An API Key will be returned.

Returns 201 if a new organization was created, 200 if an existing organization was found.

Create Organization

Gets the current indexing status across all documents.

If a collection name is passed in, it will get the indexing status of only the documents within that collection. Otherwise, it will show the cumulative status across all of your collections.

A `404 Not Found` status code will be returned, if a collection name was provided, but it does not exist.

Get Status

Adds a collection.

If the collection already exists, a `409 Conflict` status code will be returned.

Add Collection

Gets a complete list of all of your collections.

Get Collection List

Deletes a collection.

A `404 Not Found` status code will be returned, if the provided collection name does not exist.

Delete Collection

Updates a document. This endpoint is atomic.

The only attribute currently supported for update is `metadata`. This endpoint can only be called with a non-null `metadata` if the document status is `indexed`.

Sometimes, when updating a document, a new document ID will be assigned and the previous will be deleted. For this reason, the previous and the new document ID will both be returned in the response. If the document ID was not updated, then these two IDs will be identical.

A `404 Not Found` status code will be returned, if the provided collection name or document path does not exist.

Update Document

Retrieves information about a specific document. The request parameters define what information you would like to receive.

A `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.

Get Document Info

Retrives a list of document metadata information that matches the provided filters.

The documents returned will be sorted by path in lexicographically ascending order. `path_gt` can be used for pagination, and should be set to the path of the last document returned in the previous call.

A `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.

Get Document Info List

Deletes a document

A `404 Not Found` status code will be returned, if the provided collection name or document path does not exist.

Delete Document

Retrieves information about a specific page. The request parameters define what information you would like to receive.

A `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.

Get Page Info

Get the top K documents that match the given query

Top Pages

Get the top K snippets that match the given query.

You may choose between coarse and precise snippets. Precise snippets will average ~200 characters, while coarse snippets will average ~2000 characters. The default is coarse snippets. Use the `precise_responses` parameter to adjust.

Top Snippets

This provides access to the parsers that we use for indexing. This endpoint will not access any collection or search index, and the result will not be saved. This will use the same parsing method as the `/documents/add-document` endpoint.

A common use-case for this endpoint, is to use our parser in combination with your own pre-processing step, before then uploading it to the search index using the `text-pages` filetype.

Admin

Status

Collections

Documents

Queries

Parsers

Add Document

Authorizations

Body

Response