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

The Usage API from ZeroEntropy — 6 operation(s) for usage.

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

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

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

6 operations 6 paths 15 schemas 6 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 Usage 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 6

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

Usage 6
POST
/usage/documents
Get Document Usage
get_document_usage_usage_documents_post body → 200400404422
POST
/usage/queries
Get Query Usage
get_query_usage_usage_queries_post body → 200400404422
POST
/usage/models/reranker
Get Models Reranker Usage
get_models_reranker_usage_usage_models_reranker_post body → 200400404422
POST
/usage/models/embed
Get Models Embed Usage
get_models_embed_usage_usage_models_embed_post body → 200400404422
POST
/usage/models/counters
Get Models Usage Counters
get_models_usage_counters_usage_models_counters_post → 200400404422
POST
/usage/counters
Get Usage Counters
get_usage_counters_usage_counters_post → 200400404422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DocumentUsageResponse (13 properties), RerankUsageResponse (10 properties), QueryUsageResponse (10 properties), EmbedUsageResponse (8 properties). Each schema is shown below with its type and property counts.

UsageCountersResponse
object
2 properties 2 required
UsageStats
object
4 properties 4 required
DocumentUsageResponse
object
13 properties 13 required
ValidationError
object
3 properties 3 required
UsageRequest
object
4 properties 3 required
EmbedUsageResponse
object
8 properties 8 required
QueryEnum
string
DocumentEventEnum
string
UsageMetric
object
3 properties 3 required
ModelsUsageStats
object
2 properties 2 required
ModelsUsageCountersResponse
object
2 properties 2 required
HTTPValidationError
object
1 property
QueryUsageResponse
object
10 properties 10 required
AggregationWindow
string
RerankUsageResponse
object
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeroentropy-usage-api-openapi.yml Raw ↑

Other APIs ZeroEntropy publishes across the network.

ZeroEntropy Admin API
ZeroEntropy Collections API
ZeroEntropy Documents API
ZeroEntropy Models API
ZeroEntropy Queries API
ZeroEntropy Status API