helicone-api — HeliconeSql

naftiko: 1.0.0-alpha2
info:
  label: helicone-api — HeliconeSql
  description: 'helicone-api — HeliconeSql. 9 operations. Lead operation: Download query results as CSV. Self-contained Naftiko
    capability covering one Helicone business surface.'
  tags:
  - Helicone
  - HeliconeSql
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HELICONE_API_KEY: HELICONE_API_KEY
capability:
  consumes:
  - type: http
    namespace: helicone-heliconesql
    baseUri: https://api.helicone.ai
    description: helicone-api — HeliconeSql business capability. Self-contained, no shared references.
    resources:
    - name: v1-helicone-sql-download
      path: /v1/helicone-sql/download
      operations:
      - name: downloadcsv
        method: POST
        description: Download query results as CSV
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-helicone-sql-execute
      path: /v1/helicone-sql/execute
      operations:
      - name: executesql
        method: POST
        description: Execute SQL query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-helicone-sql-saved-queries
      path: /v1/helicone-sql/saved-queries
      operations:
      - name: getsavedqueries
        method: GET
        description: List saved queries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-helicone-sql-saved-queries-bulk-delete
      path: /v1/helicone-sql/saved-queries/bulk-delete
      operations:
      - name: bulkdeletesavedqueries
        method: POST
        description: Bulk delete saved queries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-helicone-sql-saved-query
      path: /v1/helicone-sql/saved-query
      operations:
      - name: createsavedquery
        method: POST
        description: Create saved query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-helicone-sql-saved-query-queryId
      path: /v1/helicone-sql/saved-query/{queryId}
      operations:
      - name: getsavedquery
        method: GET
        description: Get saved query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryId
          in: path
          type: string
          description: The ID of the saved query
          required: true
      - name: deletesavedquery
        method: DELETE
        description: Delete saved query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryId
          in: path
          type: string
          description: The ID of the saved query to delete
          required: true
      - name: updatesavedquery
        method: PUT
        description: Update saved query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryId
          in: path
          type: string
          description: The ID of the saved query to update
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-helicone-sql-schema
      path: /v1/helicone-sql/schema
      operations:
      - name: getclickhouseschema
        method: GET
        description: Get database schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.HELICONE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: helicone-heliconesql-rest
    port: 8080
    description: REST adapter for helicone-api — HeliconeSql. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/helicone-sql/download
      name: v1-helicone-sql-download
      description: REST surface for v1-helicone-sql-download.
      operations:
      - method: POST
        name: downloadcsv
        description: Download query results as CSV
        call: helicone-heliconesql.downloadcsv
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/helicone-sql/execute
      name: v1-helicone-sql-execute
      description: REST surface for v1-helicone-sql-execute.
      operations:
      - method: POST
        name: executesql
        description: Execute SQL query
        call: helicone-heliconesql.executesql
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/helicone-sql/saved-queries
      name: v1-helicone-sql-saved-queries
      description: REST surface for v1-helicone-sql-saved-queries.
      operations:
      - method: GET
        name: getsavedqueries
        description: List saved queries
        call: helicone-heliconesql.getsavedqueries
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/helicone-sql/saved-queries/bulk-delete
      name: v1-helicone-sql-saved-queries-bulk-delete
      description: REST surface for v1-helicone-sql-saved-queries-bulk-delete.
      operations:
      - method: POST
        name: bulkdeletesavedqueries
        description: Bulk delete saved queries
        call: helicone-heliconesql.bulkdeletesavedqueries
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/helicone-sql/saved-query
      name: v1-helicone-sql-saved-query
      description: REST surface for v1-helicone-sql-saved-query.
      operations:
      - method: POST
        name: createsavedquery
        description: Create saved query
        call: helicone-heliconesql.createsavedquery
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/helicone-sql/saved-query/{queryid}
      name: v1-helicone-sql-saved-query-queryid
      description: REST surface for v1-helicone-sql-saved-query-queryId.
      operations:
      - method: GET
        name: getsavedquery
        description: Get saved query
        call: helicone-heliconesql.getsavedquery
        with:
          queryId: rest.queryId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesavedquery
        description: Delete saved query
        call: helicone-heliconesql.deletesavedquery
        with:
          queryId: rest.queryId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesavedquery
        description: Update saved query
        call: helicone-heliconesql.updatesavedquery
        with:
          queryId: rest.queryId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/helicone-sql/schema
      name: v1-helicone-sql-schema
      description: REST surface for v1-helicone-sql-schema.
      operations:
      - method: GET
        name: getclickhouseschema
        description: Get database schema
        call: helicone-heliconesql.getclickhouseschema
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: helicone-heliconesql-mcp
    port: 9090
    transport: http
    description: MCP adapter for helicone-api — HeliconeSql. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: download-query-results-csv
      description: Download query results as CSV
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: helicone-heliconesql.downloadcsv
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-sql-query
      description: Execute SQL query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: helicone-heliconesql.executesql
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-saved-queries
      description: List saved queries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helicone-heliconesql.getsavedqueries
      outputParameters:
      - type: object
        mapping: $.
    - name: bulk-delete-saved-queries
      description: Bulk delete saved queries
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: helicone-heliconesql.bulkdeletesavedqueries
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-saved-query
      description: Create saved query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: helicone-heliconesql.createsavedquery
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-saved-query
      description: Get saved query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helicone-heliconesql.getsavedquery
      with:
        queryId: tools.queryId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-saved-query
      description: Delete saved query
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: helicone-heliconesql.deletesavedquery
      with:
        queryId: tools.queryId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-saved-query
      description: Update saved query
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: helicone-heliconesql.updatesavedquery
      with:
        queryId: tools.queryId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-database-schema
      description: Get database schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helicone-heliconesql.getclickhouseschema
      outputParameters:
      - type: object
        mapping: $.