Activeloop

Activeloop Storage API

The storage API from Activeloop — 10 operation(s) for storage.

GitHub OpenAPI

Operations 11

POST /api/storage Create Storage Provider #
POST /api/storage/{storage_id}/repositories Add Repository To Storage #
GET /api/org/{id}/storage Get Storage Providers #
GET /api/org/{id}/storage/name Get Storage Provider By Name #
GET /api/org/{id}/storage/is_name_available Storage Provider Exists #
DELETE /api/storage/{id} Delete Storage Provider #
PUT /api/storage/{id}/creds Update Storage Credentials #
PUT /api/storage/{id}/rename Update Storage Rename #
GET /api/repository/{repo_id}/storage Get Storage By Repository #
GET /api/organizations/{organization_id}/repository/default Get Default Repository #
POST /api/organizations/{organization_id}/repository/default Set Default Repository #

Documentation

📖
Documentation
https://docs.deeplake.ai/
📖
APIReference
https://docs-v3.activeloop.ai/
📖
Documentation
https://docs-v3.activeloop.ai/examples/tql
📖
Documentation
https://docs-v3.activeloop.ai/examples/rag/tutorials/vector-store-basics
📖
Documentation
https://docs-v3.activeloop.ai/examples/rag/tutorials/vector-search-options/rest-api

Specifications

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

Other Resources

🔗
GitHub
https://github.com/activeloopai/deeplake

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-storage-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

activeloop-storage-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Storage API
  version: 0.1.0
tags:
- name: Storage
paths:
  /api/storage:
    post:
      tags:
      - Storage
      summary: Create Storage Provider
      description: Create a storage provider.
      operationId: create_storage_provider_api_storage_post
      security:
      - HTTPBearer: []
      parameters:
      - 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/StorageCreateDataModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/storage/{storage_id}/repositories:
    post:
      tags:
      - Storage
      summary: Add Repository To Storage
      description: Add repository to storage
      operationId: add_repository_to_storage_api_storage__storage_id__repositories_post
      security:
      - HTTPBearer: []
      parameters:
      - name: storage_id
        in: path
        required: true
        schema:
          type: string
          title: Storage 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/StorageAddRepositoryData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/org/{id}/storage:
    get:
      tags:
      - Storage
      summary: Get Storage Providers
      operationId: get_storage_providers_api_org__id__storage_get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      - name: query
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query
      - 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/org/{id}/storage/name:
    get:
      tags:
      - Storage
      summary: Get Storage Provider By Name
      operationId: get_storage_provider_by_name_api_org__id__storage_name_get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      - name: query
        in: query
        required: true
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Query
      - 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/org/{id}/storage/is_name_available:
    get:
      tags:
      - Storage
      summary: Storage Provider Exists
      operationId: storage_provider_exists_api_org__id__storage_is_name_available_get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: Id
      - name: query
        in: query
        required: true
        schema:
          type: string
          title: Query
      - 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/storage/{id}:
    delete:
      tags:
      - Storage
      summary: Delete Storage Provider
      operationId: delete_storage_provider_api_storage__id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/storage/{id}/creds:
    put:
      tags:
      - Storage
      summary: Update Storage Credentials
      operationId: update_storage_credentials_api_storage__id__creds_put
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/storage/{id}/rename:
    put:
      tags:
      - Storage
      summary: Update Storage Rename
      operationId: update_storage_rename_api_storage__id__rename_put
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          title: 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/StorageRenameData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/repository/{repo_id}/storage:
    get:
      tags:
      - Storage
      summary: Get Storage By Repository
      operationId: get_storage_by_repository_api_repository__repo_id__storage_get
      security:
      - HTTPBearer: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/organizations/{organization_id}/repository/default:
    get:
      tags:
      - Storage
      summary: Get Default Repository
      description: Returns default repository.
      operationId: get_default_repository_api_organizations__organization_id__repository_default_get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization 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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Storage
      summary: Set Default Repository
      description: Set default repository.
      operationId: set_default_repository_api_organizations__organization_id__repository_default_post
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization 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/StorageSetRepositoryDefaultData'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    StorageRenameData:
      properties:
        name:
          type: string
          title: Name
      type: object
      required:
      - name
      title: StorageRenameData
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StorageType:
      type: string
      enum:
      - s3
      - gcs
      - gcs_federated
      - activeloop
      - s3:role
      - azure
      - tensor_db
      - default
      title: StorageType
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    StorageAddRepositoryData:
      properties:
        bucket_path:
          type: string
          title: Bucket Path
        make_default:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Make Default
      type: object
      required:
      - bucket_path
      title: StorageAddRepositoryData
    StorageSetRepositoryDefaultData:
      properties:
        repository_id:
          type: string
          title: Repository Id
      type: object
      required:
      - repository_id
      title: StorageSetRepositoryDefaultData
    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
    StorageCreateDataModel:
      properties:
        name:
          type: string
          title: Name
        type:
          $ref: '#/components/schemas/StorageType'
        organization:
          type: string
          title: Organization
        creds:
          additionalProperties: true
          type: object
          title: Creds
        delete_on_finish:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Delete On Finish
          default: false
      type: object
      required:
      - name
      - type
      - organization
      - creds
      title: StorageCreateDataModel
  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)