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

Helicone Credits API

The Credits API from Helicone — 6 operation(s) for credits.

Helicone Credits API is one of 33 APIs that Helicone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an API reference, and an engineering blog.

This API exposes 6 operations across 6 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.helicone.ai/, http://localhost:8585/.

6 operations 6 paths 20 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://ai-gateway.helicone.ai
Authentication
API Key
License
MIT
Resource Areas
1

Authentication & Security 1

Helicone Credits API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

  • api_key — Bearer token authentication. Format: 'Bearer YOURAPIKEY'

Paths & Operations 6

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

Credits 6
GET
/v1/credits/balance
GetCreditsBalance → 200
GET
/v1/credits/payments
ListTokenUsagePayments 2 params → 200
GET
/v1/credits/totalSpend
GetTotalSpend → 200
GET
/v1/credits/spend/breakdown
GetSpendBreakdown 3 params → 200
GET
/v1/credits/invoices
ListInvoices → 200
GET
/v1/credits/discounts
GetDiscounts → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ModelSpend (11 properties), PTBInvoice (10 properties), PurchasedCredits (4 properties), PaginatedPurchasedCredits (4 properties). Each schema is shown below with its type and property counts.

ResultSuccess_SpendBreakdownResponse_
object
2 properties 2 required
Result_PaginatedPurchasedCredits.string_
ResultSuccess_OrgDiscount-Array_
object
2 properties 2 required
CreditBalanceResponse
object
2 properties 2 required
Result_OrgDiscount-Array.string_
PurchasedCredits
object
4 properties 4 required
Result__totalSpend-number_.string_
ModelSpend
object
11 properties 10 required
OrgDiscount
object
3 properties 3 required
PaginatedPurchasedCredits
object
4 properties 4 required
SpendBreakdownResponse
object
3 properties 3 required
ResultSuccess__totalSpend-number__
object
2 properties 2 required
Result_CreditBalanceResponse.string_
PTBInvoice
object
10 properties 10 required
Result_PTBInvoice-Array.string_
ResultSuccess_PTBInvoice-Array_
object
2 properties 2 required
ResultSuccess_PaginatedPurchasedCredits_
object
2 properties 2 required
ResultSuccess_CreditBalanceResponse_
object
2 properties 2 required
Result_SpendBreakdownResponse.string_
ResultError_string_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-credits-api-openapi.yml Raw ↑

Other APIs Helicone publishes across the network.

Helicone Agent API
Helicone API Key API
Helicone Comparison API
Helicone Customer API
Helicone Dashboard API
Helicone Dataset API
Helicone Evals API
Helicone Evaluator API
Helicone Experiment API
Helicone HeliconeSql API
Helicone Integration API
Helicone Metrics API