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 Queries API

The Queries API from ZeroEntropy — 3 operation(s) for queries.

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

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

This API exposes 3 operations across 3 paths, and defines 13 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.

3 operations 3 paths 13 schemas 3 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 Queries 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 3

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

Queries 3
POST
/queries/top-documents
Top Documents
top_documents_queries_top_documents_post body → 200400404422
POST
/queries/top-pages
Top Pages
top_pages_queries_top_pages_post body → 200400404422
POST
/queries/top-snippets
Top Snippets
top_snippets_queries_top_snippets_post body → 200400404422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are TopSnippetsRequest (7 properties), TopDocumentsRequest (7 properties), TopPagesRequest (7 properties), SnippetResponse (6 properties). Each schema is shown below with its type and property counts.

DocumentMetadataJson
object
SnippetResponse
object
This is a Snippet. A snippet refers to a particular document path, and index range. Note that all documents, regardless of filetype, are converted into UTF-8-e…
6 properties 6 required
DocumentRetrievalResponse
object
4 properties 4 required
ValidationError
object
3 properties 3 required
PageRetrievalResponse
object
A Page's metadata.
5 properties 5 required
TopSnippetsRequest
object
7 properties 3 required
TopSnippetsResponse
object
2 properties 2 required
TopPagesRequest
object
7 properties 3 required
TopDocumentsResponse
object
1 property 1 required
TopPagesResponse
object
2 properties 2 required
HTTPValidationError
object
1 property
TopDocumentsRequest
object
7 properties 3 required
StrJson

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeroentropy-queries-api-openapi.yml Raw ↑

Other APIs ZeroEntropy publishes across the network.

ZeroEntropy Admin API
ZeroEntropy Collections API
ZeroEntropy Documents API
ZeroEntropy Models API
ZeroEntropy Status API
ZeroEntropy Usage API