Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZeroEntropy Documents API

The Documents API from ZeroEntropy — 8 operation(s) for documents.

ZeroEntropy Documents API is one of 7 APIs that ZeroEntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 8 operations across 8 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against 2 base URLs: https://api.zeroentropy.dev/v1, https://eu-api.zeroentropy.dev/v1.

8 operations 8 paths 21 schemas 2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.zeroentropy.dev/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ZeroEntropy Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

  • HTTPBearer — The Authorization header must be provided in the format Bearer . You can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 8
POST
/documents/add-document
Add Document
add_document_documents_add_document_post body → 200201400404409422
POST
/documents/update-document
Update Document
update_document_documents_update_document_post body → 200400404422
POST
/documents/get-document-info
Get Document Info
get_document_info_documents_get_document_info_post body → 200400404422
POST
/documents/get-document-info-list
Get Document Info List
get_document_info_list_documents_get_document_info_list_post body → 200400404422
POST
/documents/delete-document
Delete Document
delete_document_documents_delete_document_post body → 200400404422
POST
/documents/get-page-info
Get Page Info
get_page_info_documents_get_page_info_post body → 200400404422
GET
/documents/get-document
Get Document
get_document_documents_get_document_get 1 param → 200404422
GET
/documents/get-page-image
Get Page Image
get_page_image_documents_get_page_image_get 1 param → 200404422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are DocumentMetadataResponse (9 properties), DocumentResponse (9 properties), PageResponse (6 properties), AddDocumentRequest (5 properties). Each schema is shown below with its type and property counts.

GetPageInfoResponse
object
1 property 1 required
DocumentIndexStatus
string
PageResponse
object
6 properties 5 required
ValidationError
object
3 properties 3 required
DocumentMetadataResponse
object
9 properties 9 required
HTTPValidationError
object
1 property
AddDocumentRequest
object
5 properties 3 required
DocumentMetadataJson
object
GetDocumentInfoListRequest
object
4 properties 1 required
GetDocumentInfoRequest
object
3 properties 2 required
DocumentResponse
object
9 properties 8 required
DefaultResponse
object
1 property
GetDocumentInfoListResponse
object
1 property 1 required
UpdateDocumentRequest
object
4 properties 2 required
APIBinaryDocument
object
2 properties 2 required
APITextDocument
object
2 properties 2 required
DeleteDocumentRequest
object
2 properties 2 required
GetPageInfoRequest
object
4 properties 3 required
GetDocumentInfoResponse
object
1 property 1 required
DeleteDocumentResponse
object
1 property 1 required
APITextPagesDocument
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeroentropy-documents-api-openapi.yml Raw ↑

Other APIs ZeroEntropy publishes across the network.

ZeroEntropy Admin API
ZeroEntropy Collections API
ZeroEntropy Models API
ZeroEntropy Queries API
ZeroEntropy Status API
ZeroEntropy Usage API