Helicone

Helicone HeliconeSql API

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

GitHub OpenAPI

Operations 9

GET /v1/helicone-sql/schema Get database schema #
POST /v1/helicone-sql/execute Execute SQL query #
POST /v1/helicone-sql/download Download query results as CSV #
GET /v1/helicone-sql/saved-queries List saved queries #
GET /v1/helicone-sql/saved-query/{queryId} Get saved query #
DELETE /v1/helicone-sql/saved-query/{queryId} Delete saved query #
PUT /v1/helicone-sql/saved-query/{queryId} Update saved query #
POST /v1/helicone-sql/saved-queries/bulk-delete Bulk delete saved queries #
POST /v1/helicone-sql/saved-query Create saved query #

Documentation

📖
Documentation
https://docs.helicone.ai/
📖
GettingStarted
https://docs.helicone.ai/getting-started/quick-start
📖
APIReference
https://docs.helicone.ai/rest/request/post-v1requestquery
📖
Documentation
https://docs.helicone.ai/gateway/overview
📖
APIReference
https://docs.helicone.ai/rest/ai-gateway/post-v1-chat-completions
📖
Documentation
https://docs.helicone.ai/rest/request/post-v1requestquery
📖
Documentation
https://docs.helicone.ai/rest/prompts/post-v1prompt-2025
📖
Documentation
https://docs.helicone.ai/features/experiments
📖
APIReference
https://docs.helicone.ai/rest/experiment/post-v1experiment-evaluatorsrun
📖
Documentation
https://docs.helicone.ai/rest/evals/post-v1evals
📖
Documentation
https://docs.helicone.ai/features/sessions
📖
APIReference
https://docs.helicone.ai/rest/session/post-v1sessionquery
📖
Documentation
https://docs.helicone.ai/features/advanced-usage/user-metrics
📖
APIReference
https://docs.helicone.ai/rest/user/post-v1userquery
📖
Documentation
https://docs.helicone.ai/features/webhooks
📖
APIReference
https://docs.helicone.ai/rest/webhooks/get-v1webhooks
📖
Documentation
https://docs.helicone.ai/rest/models/get-v1public-model-registry-models
📖
Documentation
https://docs.helicone.ai/rest/trace/post-v1tracelog
📖
Documentation
https://docs.helicone.ai/rest/dashboard/post-v1dashboardscoresquery
📖
Documentation
https://docs.helicone.ai/features/advanced-usage/custom-properties
📖
APIReference
https://docs.helicone.ai/rest/property/post-v1propertyquery

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/helicone/refs/heads/main/openapi/helicone-heliconesql-api-openapi.yml

Other Resources

🔗
PlatformOverview
https://docs.helicone.ai/getting-started/platform-overview
🔗
Signup
https://us.helicone.ai/signup
🔗
Login
https://us.helicone.ai/signin
🔗
Portal
https://us.helicone.ai/dashboard
🔗
DeveloperPortal
https://us.helicone.ai/developer
🔗
Pricing
https://www.helicone.ai/pricing
🔗
Headers
https://docs.helicone.ai/helicone-headers/header-directory
🔗
GitHubOrg
https://github.com/Helicone/helicone
🔗
Blog
https://www.helicone.ai/blog
🔗
ChangeLog
https://www.helicone.ai/changelog
🔗
StatusPage
https://status.helicone.ai/
🔗
Contact
https://www.helicone.ai/contact
🔗
Community
https://community.helicone.ai/
🔗
Discord
https://discord.gg/2TkeWdXNPQ
🔗
Twitter
https://twitter.com/helicone_ai
🔗
LinkedIn
https://www.linkedin.com/company/helicone/
🔗
PrivacyPolicy
https://www.helicone.ai/privacy
🔗
TermsOfService
https://www.helicone.ai/terms
🔗
Security
https://docs.helicone.ai/references/data-autonomy
🔗
SelfHosted
https://docs.helicone.ai/getting-started/self-host/overview
🔗
ProviderRouting
https://docs.helicone.ai/gateway/provider-routing
🔗
Models
https://www.helicone.ai/models
🔗
Overview
https://docs.helicone.ai/features/advanced-usage/prompts/overview
🔗
Overview
https://docs.helicone.ai/features/advanced-usage/scores

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/helicone-heliconesql-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

helicone-heliconesql-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: helicone-api Agent Helicone Sql API
  version: 1.0.0
  license:
    name: MIT
  contact: {}
servers:
- url: https://api.helicone.ai/
- url: http://localhost:8585/
tags:
- name: HeliconeSql
paths:
  /v1/helicone-sql/schema:
    get:
      operationId: GetClickHouseSchema
      responses:
        '200':
          description: Array of table schemas with columns
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_ClickHouseTableSchema-Array.string_'
      description: Get ClickHouse schema (tables and columns)
      summary: Get database schema
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters: []
  /v1/helicone-sql/execute:
    post:
      operationId: ExecuteSql
      responses:
        '200':
          description: Query results with rows and metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_ExecuteSqlResponse.string_'
      description: Execute a SQL query against ClickHouse
      summary: Execute SQL query
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters: []
      requestBody:
        description: The SQL query to execute
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteSqlRequest'
              description: The SQL query to execute
  /v1/helicone-sql/download:
    post:
      operationId: DownloadCsv
      responses:
        '200':
          description: URL to download the CSV file
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_string.string_'
      description: Execute a SQL query and download results as CSV
      summary: Download query results as CSV
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters: []
      requestBody:
        description: The SQL query to execute
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteSqlRequest'
              description: The SQL query to execute
  /v1/helicone-sql/saved-queries:
    get:
      operationId: GetSavedQueries
      responses:
        '200':
          description: Array of saved queries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_Array_HqlSavedQuery_.string_'
      description: Get all saved queries for the organization
      summary: List saved queries
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters: []
  /v1/helicone-sql/saved-query/{queryId}:
    get:
      operationId: GetSavedQuery
      responses:
        '200':
          description: The saved query details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_HqlSavedQuery-or-null.string_'
      description: Get a specific saved query by ID
      summary: Get saved query
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters:
      - description: The ID of the saved query
        in: path
        name: queryId
        required: true
        schema:
          type: string
    delete:
      operationId: DeleteSavedQuery
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_void.string_'
      description: Delete a saved query by ID
      summary: Delete saved query
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters:
      - description: The ID of the saved query to delete
        in: path
        name: queryId
        required: true
        schema:
          type: string
    put:
      operationId: UpdateSavedQuery
      responses:
        '200':
          description: The updated saved query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_HqlSavedQuery.string_'
      description: Update an existing saved query
      summary: Update saved query
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters:
      - description: The ID of the saved query to update
        in: path
        name: queryId
        required: true
        schema:
          type: string
      requestBody:
        description: The updated query details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSavedQueryRequest'
              description: The updated query details
  /v1/helicone-sql/saved-queries/bulk-delete:
    post:
      operationId: BulkDeleteSavedQueries
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_void.string_'
      description: Delete multiple saved queries at once
      summary: Bulk delete saved queries
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters: []
      requestBody:
        description: Array of query IDs to delete
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDeleteSavedQueriesRequest'
              description: Array of query IDs to delete
  /v1/helicone-sql/saved-query:
    post:
      operationId: CreateSavedQuery
      responses:
        '200':
          description: Array containing the created saved query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result_HqlSavedQuery-Array.string_'
      description: Create a new saved query
      summary: Create saved query
      tags:
      - HeliconeSql
      security:
      - api_key: []
      parameters: []
      requestBody:
        description: The saved query details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSavedQueryRequest'
              description: The saved query details
components:
  schemas:
    Result_string.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_string_'
      - $ref: '#/components/schemas/ResultError_string_'
    Result_HqlSavedQuery-or-null.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_HqlSavedQuery-or-null_'
      - $ref: '#/components/schemas/ResultError_string_'
    Result_ExecuteSqlResponse.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_ExecuteSqlResponse_'
      - $ref: '#/components/schemas/ResultError_string_'
    ClickHouseTableSchema:
      properties:
        table_name:
          type: string
        columns:
          items:
            $ref: '#/components/schemas/ClickHouseTableColumn'
          type: array
      required:
      - table_name
      - columns
      type: object
      additionalProperties: false
    ResultSuccess_Array_HqlSavedQuery__:
      properties:
        data:
          items:
            $ref: '#/components/schemas/HqlSavedQuery'
          type: array
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    HqlSavedQuery:
      properties:
        id:
          type: string
        organization_id:
          type: string
        name:
          type: string
        sql:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - organization_id
      - name
      - sql
      - created_at
      - updated_at
      type: object
      additionalProperties: false
    ResultSuccess_ExecuteSqlResponse_:
      properties:
        data:
          $ref: '#/components/schemas/ExecuteSqlResponse'
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    Result_HqlSavedQuery.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_HqlSavedQuery_'
      - $ref: '#/components/schemas/ResultError_string_'
    Record_string.any_:
      properties: {}
      additionalProperties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    Result_void.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_void_'
      - $ref: '#/components/schemas/ResultError_string_'
    ResultSuccess_string_:
      properties:
        data:
          type: string
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ResultError_string_:
      properties:
        data:
          type:
          - number
          - 'null'
          enum:
          - null
        error:
          type: string
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ResultSuccess_HqlSavedQuery_:
      properties:
        data:
          $ref: '#/components/schemas/HqlSavedQuery'
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ClickHouseTableColumn:
      properties:
        name:
          type: string
        type:
          type: string
        default_type:
          type: string
        default_expression:
          type: string
        comment:
          type: string
        codec_expression:
          type: string
        ttl_expression:
          type: string
      required:
      - name
      - type
      type: object
      additionalProperties: false
    ResultSuccess_HqlSavedQuery-or-null_:
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/HqlSavedQuery'
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    CreateSavedQueryRequest:
      properties:
        name:
          type: string
        sql:
          type: string
      required:
      - name
      - sql
      type: object
      additionalProperties: false
    Result_ClickHouseTableSchema-Array.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_ClickHouseTableSchema-Array_'
      - $ref: '#/components/schemas/ResultError_string_'
    ResultSuccess_void_:
      properties:
        data: {}
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ResultSuccess_ClickHouseTableSchema-Array_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ClickHouseTableSchema'
          type: array
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    ExecuteSqlResponse:
      properties:
        rowCount:
          type: number
          format: double
        size:
          type: number
          format: double
        elapsedMilliseconds:
          type: number
          format: double
        rows:
          items:
            $ref: '#/components/schemas/Record_string.any_'
          type: array
      required:
      - rowCount
      - size
      - elapsedMilliseconds
      - rows
      type: object
    Result_HqlSavedQuery-Array.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_HqlSavedQuery-Array_'
      - $ref: '#/components/schemas/ResultError_string_'
    BulkDeleteSavedQueriesRequest:
      properties:
        ids:
          items:
            type: string
          type: array
      required:
      - ids
      type: object
      additionalProperties: false
    ResultSuccess_HqlSavedQuery-Array_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/HqlSavedQuery'
          type: array
        error:
          type:
          - number
          - 'null'
          enum:
          - null
      required:
      - data
      - error
      type: object
      additionalProperties: false
    Result_Array_HqlSavedQuery_.string_:
      anyOf:
      - $ref: '#/components/schemas/ResultSuccess_Array_HqlSavedQuery__'
      - $ref: '#/components/schemas/ResultError_string_'
    ExecuteSqlRequest:
      properties:
        sql:
          type: string
      required:
      - sql
      type: object
      additionalProperties: false
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
      description: 'Bearer token authentication. Format: ''Bearer YOUR_API_KEY'''