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

The Request API from Helicone — 10 operation(s) for request.

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

Tagged areas include Request. 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 10 operations across 10 paths, and defines 52 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/.

10 operations 10 paths 52 schemas 2 GET7 POST1 PUT

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 Request 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 10

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

Request 10
POST
/v1/request/count/query
GetRequestCount body → 200
POST
/v1/request/query
GetRequests body → 200
POST
/v1/request/query-clickhouse
GetRequestsClickhouse body → 200
GET
/v1/request/{requestId}
GetRequestById 2 params → 200
GET
/v1/request/{requestId}/inputs
GetRequestInputs 1 param → 200
POST
/v1/request/query-ids
GetRequestsByIds body → 200
POST
/v1/request/{requestId}/feedback
FeedbackRequest 1 param body → 200
PUT
/v1/request/{requestId}/property
PutProperty 1 param body → 200
POST
/v1/request/{requestId}/assets/{assetId}
GetRequestAssetById 2 params → 200
POST
/v1/request/{requestId}/score
AddScores 1 param body → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are HeliconeRequest (48 properties), Partial_RequestResponseRMTToOperators_ (37 properties), LLMRequestBody (27 properties), Message (25 properties). Each schema is shown below with its type and property counts.

FilterLeafSubset_feedback-or-request-or-response-or-properties-or-values-or-request_response_rmt-or-sessions_request_response_rmt_
Partial_RequestResponseRMTToOperators_
object
Make all properties in T optional
37 properties
Partial_SessionsRequestResponseRMTToOperators_
object
Make all properties in T optional
10 properties
Provider
SortDirection
string
ResultSuccess_HeliconeRequest-Array_
object
2 properties 2 required
LLMRequestBody
object
27 properties
Result__inputs-Record_string.any_--prompt_id-string--version_id-string--environment-string-or-null_-or-null.string_
HeliconeRequest
object
48 properties 39 required
Result_HeliconeRequest-Array.string_
FunctionCall
object
3 properties 2 required
Partial_ResponseTableToOperators_
object
Make all properties in T optional
5 properties
Scores
HeliconeRequestAsset
object
1 property 1 required
Partial_TextOperators_
object
Make all properties in T optional
6 properties
LlmSchema
object
2 properties 1 required
LLMResponseBody
object
8 properties
Response
object
17 properties 3 required
Partial_FeedbackTableToOperators_
object
Make all properties in T optional
4 properties
Partial_TimestampOperators_
object
Make all properties in T optional
5 properties
Pick_FilterLeaf.feedback-or-request-or-response-or-properties-or-values-or-request_response_rmt-or-sessions_request_response_rmt_
object
From T, pick a set of properties whose keys are in the union K
7 properties
Record_string.any_
object
Construct a type with a set of properties K of type T
Partial_BooleanOperators_
object
Make all properties in T optional
1 property
Partial_NumberOperators_
object
Make all properties in T optional
6 properties
ModelProviderName
string
HeliconeEventData
object
3 properties 2 required
Result_null.string_
Result_HeliconeRequest.string_
RequestQueryParams
object
8 properties 1 required
Message
object
25 properties 1 required
ProviderName
string
SortLeafRequest
object
17 properties
HeliconeEventVectorDB
object
7 properties 2 required
ScoreRequest
object
1 property 1 required
LlmType
string
Result_HeliconeRequestAsset.string_
ResultSuccess_null_
object
2 properties 2 required
Record_string.number_
object
Construct a type with a set of properties K of type T
RequestFilterBranch
object
3 properties 3 required
Record_string.number-or-boolean-or-undefined_
object
Construct a type with a set of properties K of type T
Record_string.string_
object
Construct a type with a set of properties K of type T
Result_number.string_
RequestFilterNode
Partial_TimestampOperatorsTyped_
object
Make all properties in T optional
5 properties
ResultSuccess_number_
object
2 properties 2 required
ResultSuccess_HeliconeRequest_
object
2 properties 2 required
Tool
object
4 properties 1 required
Partial_RequestTableToOperators_
object
Make all properties in T optional
12 properties
ResultSuccess__inputs-Record_string.any_--prompt_id-string--version_id-string--environment-string-or-null_-or-null_
object
2 properties 2 required
HeliconeEventTool
object
3 properties 3 required
ResultError_string_
object
2 properties 2 required
ResultSuccess_HeliconeRequestAsset_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-request-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