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

Affinda Usage API

Retrieve daily credits consumption for the organization across all workspaces and document types. Used for billing reconciliation, budget tracking, and FinOps reporting.

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

Tagged areas include Usage, Credits, Reporting, and FinOps. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{region}.affinda.com.

1 operations 1 paths 6 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Affinda Usage API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Usage 1
GET
/v3/usage
Get usage
getUsage 5 params → 200400401default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are UsageResponse (6 properties), UsageItem (2 properties), RequestError (2 properties). Each schema is shown below with its type and property counts.

UsageResponse
object
Daily credits consumption for an organization over a date range, optionally scoped to a single workspace or document type.
6 properties 6 required
properties-identifier
string
Uniquely identify a collection.
RequestError
object
2 properties 2 required
Organization_properties-identifier
string
Uniquely identify an organization.
UsageItem
object
Daily credits consumption for a single date in the requested period.
2 properties 2 required
identifier
string
Uniquely identify a workspace.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-usage-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Organizations API
Affinda Data Sources API
Affinda Annotations API
Affinda Validation Results API
Affinda Tags API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
Affinda Deprecated End Points API