Activeloop Legacy API

openapi: 3.2.0
info:
  title: Fast Legacy API
  version: 0.1.0
tags:
- name: Legacy
paths:
  /api/dataset/all:
    get:
      tags:
      - Legacy
      summary: Get All Datasets
      description: Get all datasets.
      operationId: get_all_datasets_api_dataset_all_get
      security:
      - HTTPBearer: []
      parameters:
      - name: public
        in: query
        required: false
        schema:
          type: string
          title: Public
      - 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:
                type: array
                items:
                  $ref: '#/components/schemas/DatasetDataModel'
                title: Response Get All Datasets Api Dataset All Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/dataset/public/search:
    get:
      tags:
      - Legacy
      summary: Search Datasets In Public
      description: Search public datasets matching a tag.
      operationId: search_datasets_in_public_api_dataset_public_search_get
      security:
      - HTTPBearer: []
      parameters:
      - name: tag
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Tag
      - name: pagesize
        in: query
        required: false
        schema:
          type: integer
          default: 10
          title: Pagesize
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - 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/dataset/search:
    get:
      tags:
      - Legacy
      summary: Search Datasets In Organization
      description: Search non-public datasets.
      operationId: search_datasets_in_organization_api_dataset_search_get
      security:
      - HTTPBearer: []
      parameters:
      - name: tag
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Tag
      - name: public
        in: query
        required: false
        schema:
          type: string
          title: Public
      - name: pagesize
        in: query
        required: false
        schema:
          type: integer
          default: 10
          title: Pagesize
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - 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:
                type: array
                items:
                  $ref: '#/components/schemas/DatasetDataModel'
                title: Response Search Datasets In Organization Api Dataset Search Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/dataset/public:
    get:
      tags:
      - Legacy
      summary: Get All Public Datasets
      description: Get a list of public datasets.
      operationId: get_all_public_datasets_api_dataset_public_get
      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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DatasetDataModel'
                title: Response Get All Public Datasets Api Dataset Public Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/dataset/popular:
    get:
      tags:
      - Legacy
      summary: Get Popular Datasets
      description: Get a list of popular datasets.
      operationId: get_popular_datasets_api_dataset_popular_get
      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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DatasetDataModel'
                title: Response Get Popular Datasets Api Dataset Popular Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/datasets/{domain}:
    get:
      tags:
      - Legacy
      summary: Get Datasets
      description: Get the dataset in a given domain.
      operationId: get_datasets_api_datasets__domain__get
      security:
      - HTTPBearer: []
      parameters:
      - name: domain
        in: path
        required: true
        schema:
          type: string
          title: Domain
      - name: organization
        in: query
        required: false
        schema:
          type: string
          title: Organization
      - 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:
                type: array
                items:
                  $ref: '#/components/schemas/DatasetDataModel'
                title: Response Get Datasets Api Datasets  Domain  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/org/stats:
    get:
      tags:
      - Legacy
      summary: Get Org Data
      operationId: get_org_data_api_org_stats_get
      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.
      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
    DatasetDataModel:
      properties:
        _id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Tag
        path:
          type: string
          title: Path
        repository:
          type: string
          title: Repository
        organization:
          type: string
          title: Organization
        user:
          type: string
          title: User
        public:
          type: boolean
          title: Public
        state:
          $ref: '#/components/schemas/DatasetState'
          default: CREATED
        progress:
          type: number
          title: Progress
          default: 0
        last_modified:
          type: number
          title: Last Modified
          default: 1791648653.7419274
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
        tags:
          items:
            type: string
          type: array
          title: Tags
          default: []
        stars:
          type: integer
          title: Stars
          default: 0
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          default: ''
        thumbnail:
          anyOf:
          - type: string
          - type: 'null'
          title: Thumbnail
          default: ''
        local:
          type: boolean
          title: Local
          default: false
        ingestion_status:
          $ref: '#/components/schemas/DatasetIngestionStatus'
          default: NOT_STARTED
        is_created_from_ingestion:
          type: boolean
          title: Is Created From Ingestion
          default: false
        api_version:
          anyOf:
          - $ref: '#/components/schemas/ApiVersion'
          - type: 'null'
          description: "The ApiVersion that should be used by scheduled pipelines when interacting with this datasset.\n                Ex. The pipeline to cleanup_deleted_datasets cloud storage uses this to determine whether to invoke the\n                2024-02-10 Dataset Deletion behavior, or the 2024-10-01 behavior where storage is cleaned up, regardless\n                 of repository type."
          default: '2024-02-10'
        available_regions:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Available Regions
          description: List of regions where the dataset is available for replication. In AWS format.
        is_v4:
          type: boolean
          title: Is V4
          readOnly: true
      type: object
      required:
      - _id
      - name
      - path
      - repository
      - organization
      - user
      - public
      - is_v4
      title: DatasetDataModel
      example:
        _id: mnist/fashion-mnist
        last_modified: 1604371311.3946
        meta:
          len: 70000
          tensors:
            data:
              STORE_VERSION: 1
              chunksize: 32768
              dcompress_algo: None
              dtag: mask
              dtype: uint8
              preprocessed: true
              shape:
              - 28
              - 28
            labels:
              STORE_VERSION: 1
              chunksize: 16777216
              dcompress_algo: None
              dtag: text
              dtype: int8
              preprocessed: true
              shape:
              - 70000
        name: fashion-mnist
        organization: mnist
        path: s3://snark-hub/public/mnist/fashion-mnist
        progress: 0
        public: false
        repository: public/mnist
        state: CREATED
        tag: mnist/fashion-mnist
        user: mnist
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    DatasetState:
      type: string
      enum:
      - CREATED
      - UPLOADING
      - UPLOADED
      - SCHEDULED_FOR_DELETION
      - DELETED
      title: DatasetState
    DatasetIngestionStatus:
      type: string
      enum:
      - NOT_STARTED
      - IN_PROGRESS
      - IN_QUEUE
      - FETCHING
      - GENERATING_SUMMARY
      - INGESTING
      - UPLOADING
      - SUCCESS
      - ERROR
      title: DatasetIngestionStatus
    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)