Activeloop

Activeloop Openai API

The openai API from Activeloop — 4 operation(s) for openai.

Documentation GitHub OpenAPI

Operations 4

POST /api/tql/{organization_id}/{dataset_id}/suggest Get Tql Completion #

PUT /api/tql/{generated_query_id} Set Generated Query Validity #

PUT /api/tql/{generated_query_id}/feedback Set Generated Query Feedback #

POST /api/tql/{organization_id}/{dataset_id}/reason_stream Reason Stream #

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/activeloop:activeloop-openai-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

openapi: 3.2.0
info:
  title: Fast Openai API
  version: 0.1.0
tags:
- name: Openai
paths:
  /api/tql/{organization_id}/{dataset_id}/suggest:
    post:
      tags:
      - Openai
      summary: Get Tql Completion
      description: Get TQL prompt completion for a dataset
      operationId: get_tql_completion_api_tql__organization_id___dataset_id__suggest_post
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          title: Dataset Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TQLCompletionData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/tql/{generated_query_id}:
    put:
      tags:
      - Openai
      summary: Set Generated Query Validity
      description: Set the validity status of a generated quersy
      operationId: set_generated_query_validity_api_tql__generated_query_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: generated_query_id
        in: path
        required: true
        schema:
          type: string
          title: Generated Query Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetQueryStatusData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/tql/{generated_query_id}/feedback:
    put:
      tags:
      - Openai
      summary: Set Generated Query Feedback
      description: Set the feedback for a query coming from the user.
      operationId: set_generated_query_feedback_api_tql__generated_query_id__feedback_put
      security:
      - HTTPBearer: []
      parameters:
      - name: generated_query_id
        in: path
        required: true
        schema:
          type: string
          title: Generated Query Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetQueryFeedbackData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/tql/{organization_id}/{dataset_id}/reason_stream:
    post:
      tags:
      - Openai
      summary: Reason Stream
      description: Stream a reasoning for a dataset
      operationId: reason_stream_api_tql__organization_id___dataset_id__reason_stream_post
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_id
        in: path
        required: true
        schema:
          type: string
          title: Dataset Id
      - name: hard_fail
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Hard Fail
      - name: require_profile
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Require Profile
      - name: Activeloop-Api-Version
        in: header
        required: false
        schema:
          $ref: '#/components/schemas/ApiVersion'
          title: Activeloop API Version
          description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
          default: '2024-02-10'
        description: Controls which version of the Activeloop API gets used to execute client Requests. Leaving this out will default to the oldest currently supported API behavior.<br>`2024-02-10` is equivalent to omitting this header entirely as it is the oldest version.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TQLReasoningData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TQLCompletionData:
      properties:
        user_prompt:
          type: string
          title: User Prompt
        dataset_structure:
          type: string
          title: Dataset Structure
        history:
          anyOf:
          - items:
              additionalProperties:
                type: string
              type: object
            type: array
          - type: 'null'
          title: History
          description: history of messages sent by the user
          default: []
      type: object
      required:
      - user_prompt
      - dataset_structure
      title: TQLCompletionData
    TQLReasoningData:
      properties:
        user_prompt:
          type: string
          title: User Prompt
        dataset_structure:
          type: string
          title: Dataset Structure
        dataset_rows:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Dataset Rows
          description: top relevant dataset rows with index as key and row as total value
          default: []
        history:
          anyOf:
          - items:
              additionalProperties:
                type: string
              type: object
            type: array
          - type: 'null'
          title: History
          description: history of messages sent by the user
          default: []
      type: object
      required:
      - user_prompt
      - dataset_structure
      title: TQLReasoningData
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    SetQueryFeedbackData:
      properties:
        feedback:
          type: integer
          title: Feedback
      type: object
      required:
      - feedback
      title: SetQueryFeedbackData
    SetQueryStatusData:
      properties:
        valid:
          type: boolean
          title: Valid
        tql_error:
          anyOf:
          - {}
          - type: 'null'
          title: Tql Error
          description: Error message from TQL
      type: object
      required:
      - valid
      title: SetQueryStatusData
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Activeloop
  source: https://app.activeloop.ai/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)