Activeloop Managed Database API

The Managed Database API from Activeloop — 1 operation(s) for managed database.

OpenAPI Specification

activeloop-managed-database-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Activeloop Deep Lake Managed Database API
  description: Deep Lake is a database for AI built by Activeloop. Its PRIMARY interface is the open-source `deeplake` Python SDK paired with the Tensor Query Language (TQL) - datasets and embeddings are created, versioned, queried, and streamed through Python, not through a broad REST API. The only documented HTTP/REST surface is the alpha Managed Database query endpoint at https://app.activeloop.ai/api/query/v1, which accepts a TQL query string and returns results for datasets hosted in the Activeloop Managed Tensor Database. That single endpoint is modeled below; no other REST endpoints are fabricated. For dataset creation, ingestion, version control, vector store operations, and most queries, use the Deep Lake Python SDK (https://docs.deeplake.ai/) and TQL.
  termsOfService: https://www.activeloop.ai/terms-of-service/
  contact:
    name: Activeloop Support
    url: https://www.activeloop.ai/
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: v1-alpha
servers:
- url: https://app.activeloop.ai
  description: Activeloop Cloud (Managed Tensor Database)
tags:
- name: Managed Database
paths:
  /api/query/v1:
    post:
      operationId: runManagedQuery
      tags:
      - Managed Database
      summary: Run a TQL query against the Managed Tensor Database (Alpha).
      description: 'Executes a Tensor Query Language (TQL) query against a dataset hosted in the Activeloop Managed Tensor Database (datasets created with `runtime={"tensor_db": True}`). This endpoint is documented as Alpha and its syntax may change without announcement. Most Deep Lake usage runs through the Python SDK rather than this endpoint.'
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Query executed successfully; results returned as JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
        '401':
          description: Missing or invalid ACTIVELOOP_TOKEN.
        '400':
          description: Malformed TQL query or request body.
components:
  schemas:
    QueryRequest:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          description: A Tensor Query Language (TQL) statement, e.g. `select * from "hub://org_id/dataset_name" where ...`.
          example: select * from "hub://activeloop/dataset" limit 10
    QueryResponse:
      type: object
      description: JSON results of the query. The exact response shape is not formally documented by Activeloop (Alpha); results are returned as query rows.
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Activeloop API token passed as `Authorization: Bearer {ACTIVELOOP_TOKEN}`.'