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

The User API from Helicone — 3 operation(s) for user.

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

Tagged areas include User. 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 3 operations across 3 paths, and defines 24 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/.

3 operations 3 paths 24 schemas 3 POST

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 User 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 3

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

User 3
POST
/v1/user/metrics-overview/query
GetUserMetricsOverview body → 200
POST
/v1/user/metrics/query
GetUserMetrics body → 200
POST
/v1/user/query
GetUsers body → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Partial_RequestResponseRMTToOperators_ (37 properties), SortLeafUsers (12 properties), UserMetricsResult (11 properties), Partial_UserViewToOperators_ (10 properties). Each schema is shown below with its type and property counts.

Partial_RequestResponseRMTToOperators_
object
Make all properties in T optional
37 properties
SortDirection
string
FilterLeafSubset_users_view-or-request_response_rmt_
Result__request_count-HistogramRow-Array--user_cost-HistogramRow-Array_.string_
UserFilterNode
Partial_TextOperators_
object
Make all properties in T optional
6 properties
Result__count-number--prompt_tokens-number--completion_tokens-number--user_id-string--cost-number_-Array.string_
ResultSuccess__request_count-HistogramRow-Array--user_cost-HistogramRow-Array__
object
2 properties 2 required
ResultSuccess__users-UserMetricsResult-Array--count-number--hasUsers-boolean__
object
2 properties 2 required
UserQueryParams
object
2 properties
HistogramRow
object
3 properties 3 required
Partial_BooleanOperators_
object
Make all properties in T optional
1 property
Partial_NumberOperators_
object
Make all properties in T optional
6 properties
ResultSuccess__count-number--prompt_tokens-number--completion_tokens-number--user_id-string--cost-number_-Array_
object
2 properties 2 required
PSize
string
UserMetricsQueryParams
object
6 properties 3 required
Pick_FilterLeaf.users_view-or-request_response_rmt_
object
From T, pick a set of properties whose keys are in the union K
2 properties
SortLeafUsers
object
12 properties
UserFilterBranch
object
3 properties 3 required
Partial_TimestampOperatorsTyped_
object
Make all properties in T optional
5 properties
UserMetricsResult
object
11 properties 11 required
Partial_UserViewToOperators_
object
Make all properties in T optional
10 properties
ResultError_string_
object
2 properties 2 required
Result__users-UserMetricsResult-Array--count-number--hasUsers-boolean_.string_

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-user-api-openapi.yml Raw ↑

Other APIs Helicone publishes across the network.

Helicone Agent API
Helicone API Key API
Helicone Comparison API
Helicone Credits 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