Home page

Community

Blog

API Reference

ZeroEntropy

Support

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

DocumentIndexStatus

Collection Name

This will be `null`, unless `include_content` was available and set to `true`.

Content

The number of pages in this document. This will be `null` if the document is parsing or failed to parse. It can also be `null` if the document is a filetype that does not support pages.

Num Pages

Path

DocumentResponse

Location

Message

Error Type

ValidationError

GetDocumentInfoRequest

HTTPBearer

GetDocumentInfoResponse

HTTPValidationError

Welcome to the ZeroEntropy documentation.

Introduction

Understand the core concepts of the ZeroEntropy API.

Core Concepts

Getting Started using the ZeroEntropy API

Quickstart

Client Code

Client Example Usage

Metadata Filtering

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

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

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

The documents returned will be sorted by ID in ascending order. `id_gt` can be used for pagination, and should be set to the ID 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.

Status

Collections

Documents

Queries

Parsers

Get Document Info

Authorizations

Body

Response