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

The Property API from Helicone — 8 operation(s) for property.

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

Tagged areas include Property. 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 8 operations across 8 paths, and defines 26 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/.

8 operations 8 paths 26 schemas 8 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 Property 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 8

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

Property 8
POST
/v1/property/properties/over-time
GetPropertiesOverTime body → 200
POST
/v1/property/query
GetProperties body → 200
POST
/v1/property/hide
HideProperty body → 200
POST
/v1/property/hidden/query
GetHiddenProperties → 200
POST
/v1/property/restore
RestoreProperty body → 200
POST
/v1/property/{propertyKey}/search
SearchProperties 1 param body → 200
POST
/v1/property/{propertyKey}/top-costs/query
GetTopCosts 1 param body → 200
POST
/v1/property/{propertyKey}/top-requests/query
GetTopRequests 1 param body → 200

Schemas 26

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

Partial_RequestResponseRMTToOperators_
object
Make all properties in T optional
37 properties
Property
object
1 property 1 required
Result_string-Array.string_
Result__property-string--total_cost-number--request_count-number--created_at_trunc-string_-Array.string_
DataOverTimeRequest
object
4 properties 4 required
Partial_TextOperators_
object
Make all properties in T optional
6 properties
Result__value-string--cost-number_-Array.string_
TimeFilterRequest
object
1 property 1 required
ResultSuccess__value-string--cost-number_-Array_
object
2 properties 2 required
Result_Property-Array.string_
RequestClickhouseFilterBranch
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__value-string--count-number_-Array_
object
2 properties 2 required
TimeIncrement
string
Result__value-string--count-number_-Array.string_
ResultSuccess_unknown-Array_
object
2 properties 2 required
RequestClickhouseFilterNode
ResultSuccess_Property-Array_
object
2 properties 2 required
ResultSuccess_string-Array_
object
2 properties 2 required
ResultSuccess_string_
object
2 properties 2 required
Partial_TimestampOperatorsTyped_
object
Make all properties in T optional
5 properties
FilterLeafSubset_request_response_rmt_
ResultSuccess__property-string--total_cost-number--request_count-number--created_at_trunc-string_-Array_
object
2 properties 2 required
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-property-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