LogoLogo
  • 🔬Activeloop
  • 🏠Setup
    • Quickstart
  • Models & Pricing
  • 📖User Guide
    • Ingesting with Metadata
      • Modalities
    • Filtering Query
      • Query Syntax
    • Streaming Output
  • 🏗️API Reference
    • Chat Completions
    • Files
    • Workspaces
Powered by GitBook
On this page
Export as PDF
  1. API Reference

Chat Completions

PreviousStreaming OutputNextFiles

Last updated 1 day ago

🏗️

List Completions

get

List stored Chat Completions

Authorizations
Query parameters
workspacestringOptional

The ID of workspace to lookup chat completions in

Default: default
afterany ofOptional

Identifier for the last chat completion from the previous pagination request

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 100Optional

Number of Chat Completions to retrieve

Default: 20
orderstring · enumOptional

Sort order for Chat Completions by timestamp

Default: ascPossible values:
modelany ofOptional

Filter by model

stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /chat/completions HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "object": "chat.completion",
      "created": 1,
      "model": "text",
      "system_fingerprint": "text",
      "choices": [
        {
          "index": 1,
          "message": {
            "role": "system",
            "content": "text",
            "reasoning_content": "text",
            "refusal": null,
            "annotations": [
              {
                "type": "text",
                "text": "text",
                "start_index": 1,
                "end_index": 1,
                "file_citation": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "file_path": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              }
            ]
          },
          "finish_reason": "text",
          "logprobs": {
            "content": [
              {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            ]
          },
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "usage": {
        "prompt_tokens": 1,
        "completion_tokens": 1,
        "total_tokens": 1
      },
      "perception_usage": {
        "prompt_tokens": 1,
        "completion_tokens": 1,
        "total_tokens": 1
      },
      "service_tier": "text",
      "request_id": "text",
      "seed": 1,
      "top_p": 1,
      "temperature": 1,
      "presence_penalty": 1,
      "frequency_penalty": 1,
      "input_user": "text",
      "tools": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "response_format": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "responses": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "first_id": "text",
  "last_id": "text",
  "has_more": false
}

Get Chat Completion

get

Get a stored chat completion

Authorizations
Path parameters
completion_idstringRequired

The ID of the chat completion to retrieve

Query parameters
workspacestringOptional

The ID of workspace to lookup chat completion in

Default: default
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /chat/completions/{completion_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "object": "chat.completion",
  "created": 1,
  "model": "text",
  "system_fingerprint": "text",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "text",
        "reasoning_content": "text",
        "refusal": null,
        "annotations": [
          {
            "type": "text",
            "text": "text",
            "start_index": 1,
            "end_index": 1,
            "file_citation": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "file_path": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "finish_reason": "text",
      "logprobs": {
        "content": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  },
  "perception_usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  },
  "service_tier": "text",
  "request_id": "text",
  "seed": 1,
  "top_p": 1,
  "temperature": 1,
  "presence_penalty": 1,
  "frequency_penalty": 1,
  "input_user": "text",
  "tools": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "response_format": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "responses": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Chat Completion Messages

get

Get messages for a chat completion

Authorizations
Path parameters
completion_idstringRequired

The ID of the chat completion

Query parameters
workspacestringOptional

The ID of workspace to lookup chat completion messages in

Default: default
afterany ofOptional

Identifier for the last message from the previous pagination request

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 100Optional

Number of messages to retrieve

Default: 20
orderstringOptional

Sort order for messages by timestamp

Default: asc
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /chat/completions/{completion_id}/messages HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "role": "system",
      "content": "text",
      "name": "text",
      "content_parts": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "first_id": "text",
  "last_id": "text",
  "has_more": false
}

Delete Chat Completion

delete

Delete a chat completion

Authorizations
Path parameters
completion_idstringRequired

The ID of the chat completion to delete

Query parameters
workspacestringOptional

The ID of workspace to delete chat completion in

Default: default
Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /chat/completions/{completion_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "object": "chat.completion.deleted",
  "deleted": true
}
  • POSTCreate Chat Completion
  • GETGet Chat Completion Messages
  • GETList Completions
  • GETGet Chat Completion
  • POSTUpdate Chat Completion
  • GETGet Chat Completion Messages
  • DELETEDelete Chat Completion

Get Chat Completion Messages

get

Get messages for a chat completion

Authorizations
Path parameters
completion_idstringRequired

The ID of the chat completion

Query parameters
workspacestringOptional

The ID of workspace to lookup chat completion messages in

Default: default
afterany ofOptional

Identifier for the last message from the previous pagination request

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 100Optional

Number of messages to retrieve

Default: 20
orderstringOptional

Sort order for messages by timestamp

Default: asc
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /chat/completions/{completion_id}/messages HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Accept: */*

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "role": "system",
      "content": "text",
      "name": "text",
      "content_parts": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "first_id": "text",
  "last_id": "text",
  "has_more": false
}

Create Chat Completion

post

Create a chat completion with OpenAI-compatible format

Authorizations
Body
workspacestringOptionalDefault: default
modelstringOptionalDefault: activeloop-l0
temperatureany ofOptionalDefault: 1
numberOptional
or
nullOptional
top_pany ofOptionalDefault: 1
numberOptional
or
nullOptional
nany ofOptionalDefault: 1
integerOptional
or
nullOptional
streamany ofOptionalDefault: false
booleanOptional
or
nullOptional
max_tokensany ofOptional
integerOptional
or
nullOptional
max_completion_tokensany ofOptional
integerOptional
or
nullOptional
presence_penaltyany ofOptionalDefault: 0
numberOptional
or
nullOptional
frequency_penaltyany ofOptionalDefault: 0
numberOptional
or
nullOptional
logit_biasany ofOptional
or
nullOptional
logprobsany ofOptionalDefault: false
booleanOptional
or
nullOptional
top_logprobsany ofOptional
integerOptional
or
nullOptional
stopany ofOptional
stringOptional
or
string[]Optional
or
nullOptional
seedany ofOptional
integerOptional
or
nullOptional
response_formatany ofOptional
or
nullOptional
userany ofOptional
stringOptional
or
nullOptional
stream_optionsany ofOptional
or
nullOptional
storeany ofOptionalDefault: false
booleanOptional
or
nullOptional
metadataany ofOptional
or
nullOptional
modalitiesany ofOptional
string[]Optional
or
nullOptional
service_tierany ofOptional
stringOptional
or
nullOptional
reasoning_effortany ofOptional
string · enumOptionalPossible values:
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
POST /chat/completions HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 566

{
  "workspace": "default",
  "model": "activeloop-l0",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "text"
        }
      ]
    }
  ],
  "temperature": 1,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "max_tokens": 1,
  "max_completion_tokens": 1,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "logit_bias": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "logprobs": false,
  "top_logprobs": 1,
  "stop": "text",
  "seed": 1,
  "response_format": {
    "type": "text"
  },
  "user": "text",
  "stream_options": {
    "include_usage": true
  },
  "store": false,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "modalities": [
    "text"
  ],
  "service_tier": "text",
  "reasoning_effort": "low"
}
No content

Update Chat Completion

post

Update metadata for a chat completion

Authorizations
Path parameters
completion_idstringRequired

The ID of the chat completion to update

Query parameters
workspacestringOptional

The ID of workspace to update chat completion in

Default: default
Body
Other propertiesstringOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /chat/completions/{completion_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}
{
  "id": "text",
  "object": "chat.completion",
  "created": 1,
  "model": "text",
  "system_fingerprint": "text",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "text",
        "reasoning_content": "text",
        "refusal": null,
        "annotations": [
          {
            "type": "text",
            "text": "text",
            "start_index": 1,
            "end_index": 1,
            "file_citation": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "file_path": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "finish_reason": "text",
      "logprobs": {
        "content": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  },
  "perception_usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  },
  "service_tier": "text",
  "request_id": "text",
  "seed": 1,
  "top_p": 1,
  "temperature": 1,
  "presence_penalty": 1,
  "frequency_penalty": 1,
  "input_user": "text",
  "tools": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "response_format": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "responses": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}