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

The Evals API from Helicone — 4 operation(s) for evals.

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

Tagged areas include Evals. 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 4 operations across 4 paths, and defines 21 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/.

4 operations 4 paths 21 schemas 1 GET3 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 Evals 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 4

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

Evals 4
POST
/v1/evals/query
QueryEvals body → 200
GET
/v1/evals/scores
GetEvalScores → 200
POST
/v1/evals/{requestId}
AddEval 1 param body → 200
POST
/v1/evals/score-distributions/query
QueryScoreDistributions body → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Partial_RequestResponseRMTToOperators_ (37 properties), Eval (7 properties), Partial_TextOperators_ (6 properties), Partial_NumberOperators_ (6 properties). Each schema is shown below with its type and property counts.

Eval
object
7 properties 7 required
Partial_RequestResponseRMTToOperators_
object
Make all properties in T optional
37 properties
Result_string-Array.string_
EvalFilterBranch
object
3 properties 3 required
ResultSuccess_Eval-Array_
object
2 properties 2 required
Partial_TextOperators_
object
Make all properties in T optional
6 properties
Result_Eval-Array.string_
Partial_BooleanOperators_
object
Make all properties in T optional
1 property
Partial_NumberOperators_
object
Make all properties in T optional
6 properties
Result_null.string_
EvalQueryParams
object
5 properties 2 required
ScoreDistribution
object
2 properties 2 required
ResultSuccess_null_
object
2 properties 2 required
ResultSuccess_ScoreDistribution-Array_
object
2 properties 2 required
ResultSuccess_string-Array_
object
2 properties 2 required
EvalFilterNode
Partial_TimestampOperatorsTyped_
object
Make all properties in T optional
5 properties
Result_ScoreDistribution-Array.string_
FilterLeafSubset_request_response_rmt_
Pick_FilterLeaf.request_response_rmt_
object
From T, pick a set of properties whose keys are in the union K
1 property
ResultError_string_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-evals-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 Evaluator API
Helicone Experiment API
Helicone HeliconeSql API
Helicone Integration API
Helicone Metrics API