Activeloop

Activeloop Deepmemory API

The deepmemory API from Activeloop — 7 operation(s) for deepmemory.

Documentation GitHub OpenAPI

Operations 7

GET /api/deepmemory/v1/{organization_id}/{dataset_name}/jobs Get Jobs For Datset #

GET /api/deepmemory/v1/jobs/{job_id}/status Get Job Status #

POST /api/deepmemory/v1/jobs/{job_id}/cancel Cancel Job #

DELETE /api/deepmemory/v1/jobs/{job_id} Delete Job #

POST /api/deepmemory/v1/generate_queries Generate Queries #

POST /api/deepmemory/v1/train Train Deepmemory Model #

POST /api/deepmemory/v1/jobs/{job_id}/log Log #

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-deepmemory-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 Deepmemory API
  version: 0.1.0
tags:
- name: deepmemory
paths:
  /api/deepmemory/v1/{organization_id}/{dataset_name}/jobs:
    get:
      tags:
      - deepmemory
      summary: Get Jobs For Datset
      operationId: get_jobs_for_datset_api_deepmemory_v1__organization_id___dataset_name__jobs_get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          title: Organization Id
      - name: dataset_name
        in: path
        required: true
        schema:
          type: string
          title: Dataset Name
      - 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/DeepMemoryJobDTO'
                title: Response Get Jobs For Datset Api Deepmemory V1  Organization Id   Dataset Name  Jobs Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/deepmemory/v1/jobs/{job_id}/status:
    get:
      tags:
      - deepmemory
      summary: Get Job Status
      operationId: get_job_status_api_deepmemory_v1_jobs__job_id__status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job 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:
                $ref: '#/components/schemas/DeepMemoryJobDTO'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/deepmemory/v1/jobs/{job_id}/cancel:
    post:
      tags:
      - deepmemory
      summary: Cancel Job
      operationId: cancel_job_api_deepmemory_v1_jobs__job_id__cancel_post
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job 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/deepmemory/v1/jobs/{job_id}:
    delete:
      tags:
      - deepmemory
      summary: Delete Job
      operationId: delete_job_api_deepmemory_v1_jobs__job_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job 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:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/deepmemory/v1/generate_queries:
    post:
      tags:
      - deepmemory
      summary: Generate Queries
      operationId: generate_queries_api_deepmemory_v1_generate_queries_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/GenerateQueriesSchema'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateQueriesResponseSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/deepmemory/v1/train:
    post:
      tags:
      - deepmemory
      summary: Train Deepmemory Model
      operationId: train_deepmemory_model_api_deepmemory_v1_train_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/StartTrainingJobSchema'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartTrainingJobResponseSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/deepmemory/v1/jobs/{job_id}/log:
    post:
      tags:
      - deepmemory
      summary: Log
      operationId: log_api_deepmemory_v1_jobs__job_id__log_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          title: Job Id
      - 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/UpdateDeepMemoryJobProgressSchema'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UpdateDeepMemoryJobProgressSchema:
      properties:
        job_secret:
          type: string
          title: Job Secret
        status:
          $ref: '#/components/schemas/DeepMemoryJobStatus'
        progress:
          anyOf:
          - additionalProperties: true
            type: object
          - type: string
          - type: 'null'
          title: Progress
        timestamp:
          anyOf:
          - type: number
          - type: 'null'
          title: Timestamp
      type: object
      required:
      - job_secret
      - status
      title: UpdateDeepMemoryJobProgressSchema
    DeepMemoryJobStatus:
      type: string
      enum:
      - pending
      - cancelled
      - started
      - loading
      - training
      - failed
      - completed
      title: DeepMemoryJobStatus
    StartTrainingJobResponseSchema:
      properties:
        job_id:
          type: string
          title: Job Id
      type: object
      required:
      - job_id
      title: StartTrainingJobResponseSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GenerateQueriesSchema:
      properties:
        corpus_dataset:
          type: string
          title: Corpus Dataset
        n:
          type: integer
          title: N
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          default: gpt-3.5-turbo
        questions:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Questions
      type: object
      required:
      - corpus_dataset
      - n
      - questions
      title: GenerateQueriesSchema
    ApiVersion:
      type: string
      enum:
      - '2024-02-10'
      - '2024-10-01'
      title: ApiVersion
    StartTrainingJobSchema:
      properties:
        corpus_dataset:
          type: string
          title: Corpus Dataset
        query_dataset:
          type: string
          title: Query Dataset
      type: object
      required:
      - corpus_dataset
      - query_dataset
      title: StartTrainingJobSchema
    DeepMemoryJobProgress:
      properties:
        eta:
          anyOf:
          - type: number
          - type: 'null'
          title: Eta
          description: The timestamp of the ETA in seconds since epoch.
        last_updated_at:
          type: number
          title: Last Updated At
          description: The timestamp of the last update in seconds since epoch.
          default: 1791648657.896572
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
          description: The error message if the job failed.
      additionalProperties: true
      type: object
      title: DeepMemoryJobProgress
    GenerateQueriesResponseSchema:
      properties:
        questions:
          items:
            type: string
          type: array
          title: Questions
        relevance:
          items:
            items:
              prefixItems:
              - type: string
              - type: integer
              type: array
              maxItems: 2
              minItems: 2
            type: array
          type: array
          title: Relevance
      type: object
      required:
      - questions
      - relevance
      title: GenerateQueriesResponseSchema
    DeepMemoryJobDTO:
      properties:
        _id:
          type: string
          title: Id
        dataset_id:
          type: string
          title: Dataset Id
          description: The dataset id associated with the job.
        organization_id:
          type: string
          title: Organization Id
          description: The organization id associated with the job.
        status:
          $ref: '#/components/schemas/DeepMemoryJobStatus'
        progress:
          anyOf:
          - $ref: '#/components/schemas/DeepMemoryJobProgress'
          - type: 'null'
          description: The ETA of the job.
      type: object
      required:
      - dataset_id
      - organization_id
      - status
      title: DeepMemoryJobDTO
    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)