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

The HeliconeSql API from Helicone — 7 operation(s) for heliconesql.

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

Tagged areas include HeliconeSql. 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 9 operations across 7 paths, and defines 25 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/.

9 operations 7 paths 25 schemas 1 DELETE3 GET4 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 HeliconeSql 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 9

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

HeliconeSql 9
GET
/v1/helicone-sql/schema
Get database schema
GetClickHouseSchema → 200
POST
/v1/helicone-sql/execute
Execute SQL query
ExecuteSql body → 200
POST
/v1/helicone-sql/download
Download query results as CSV
DownloadCsv body → 200
GET
/v1/helicone-sql/saved-queries
List saved queries
GetSavedQueries → 200
GET
/v1/helicone-sql/saved-query/{queryId}
Get saved query
GetSavedQuery 1 param → 200
DELETE
/v1/helicone-sql/saved-query/{queryId}
Delete saved query
DeleteSavedQuery 1 param → 200
PUT
/v1/helicone-sql/saved-query/{queryId}
Update saved query
UpdateSavedQuery 1 param body → 200
POST
/v1/helicone-sql/saved-queries/bulk-delete
Bulk delete saved queries
BulkDeleteSavedQueries body → 200
POST
/v1/helicone-sql/saved-query
Create saved query
CreateSavedQuery body → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ClickHouseTableColumn (7 properties), HqlSavedQuery (6 properties), ExecuteSqlResponse (4 properties), ResultSuccess_ExecuteSqlResponse_ (2 properties). Each schema is shown below with its type and property counts.

CreateSavedQueryRequest
object
2 properties 2 required
ResultSuccess_void_
object
2 properties 2 required
Result_HqlSavedQuery-or-null.string_
Result_ExecuteSqlResponse.string_
Result_HqlSavedQuery.string_
ExecuteSqlResponse
object
4 properties 4 required
Result_ClickHouseTableSchema-Array.string_
ResultSuccess_HqlSavedQuery-Array_
object
2 properties 2 required
ClickHouseTableSchema
object
2 properties 2 required
Result_HqlSavedQuery-Array.string_
BulkDeleteSavedQueriesRequest
object
1 property 1 required
Record_string.any_
object
Construct a type with a set of properties K of type T
Result_void.string_
Result_string.string_
HqlSavedQuery
object
6 properties 6 required
ResultSuccess_Array_HqlSavedQuery__
object
2 properties 2 required
Result_Array_HqlSavedQuery_.string_
ResultSuccess_ClickHouseTableSchema-Array_
object
2 properties 2 required
ExecuteSqlRequest
object
1 property 1 required
ClickHouseTableColumn
object
7 properties 2 required
ResultSuccess_string_
object
2 properties 2 required
ResultSuccess_ExecuteSqlResponse_
object
2 properties 2 required
ResultSuccess_HqlSavedQuery_
object
2 properties 2 required
ResultSuccess_HqlSavedQuery-or-null_
object
2 properties 2 required
ResultError_string_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-heliconesql-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 Integration API
Helicone Metrics API