Chat Completions

Create Chat Completion

post

/chat/completions

Create a chat completion with OpenAI-compatible format

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Body

workspacestringOptionalDefault: default

modelstringOptionalDefault: activeloop-l0

temperaturenumber · nullableOptionalDefault: 1

top_pnumber · nullableOptionalDefault: 1

ninteger · nullableOptionalDefault: 1

streamboolean · nullableOptionalDefault: false

max_tokensinteger · nullableOptional

max_completion_tokensinteger · nullableOptional

presence_penaltynumber · nullableOptionalDefault: 0

frequency_penaltynumber · nullableOptionalDefault: 0

logprobsboolean · nullableOptionalDefault: false

top_logprobsinteger · nullableOptional

stopany of · nullableOptional

stringOptional

or

string[]Optional

seedinteger · nullableOptional

userstring · nullableOptional

storeboolean · nullableOptionalDefault: false

modalitiesstring[] · nullableOptional

service_tierstring · nullableOptional

reasoning_effortstring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post/chat/completions

POST /chat/completions HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
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

Get Chat Completion Messages

get

/chat/completions/{completion_id}/messages

Get messages for a chat completion

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

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

afterstring · nullableOptional

Identifier for the last message from the previous pagination request

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

objectstringOptionalDefault: list

first_idstring · nullableOptional

last_idstring · nullableOptional

has_morebooleanOptionalDefault: false

422

Validation Error

application/json

get/chat/completions/{completion_id}/messages

GET /chat/completions/{completion_id}/messages HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
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
}

List Completions

get

/chat/completions

List stored Chat Completions

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Query parameters

workspacestringOptional

The ID of workspace to lookup chat completions in

Default: default

afterstring · nullableOptional

Identifier for the last chat completion from the previous pagination request

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:

modelstring · nullableOptional

Filter by model

Responses

200

Successful Response

application/json

objectstringOptionalDefault: list

first_idstring · nullableOptional

last_idstring · nullableOptional

has_morebooleanOptionalDefault: false

422

Validation Error

application/json

get/chat/completions

GET /chat/completions HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
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

/chat/completions/{completion_id}

Get a stored chat completion

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

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

idstringOptional

objectstringOptionalDefault: chat.completion

createdintegerOptional

modelstringRequired

system_fingerprintstring · nullableOptional

service_tierstring · nullableOptional

request_idstring · nullableOptional

seedinteger · nullableOptional

top_pnumber · nullableOptional

temperaturenumber · nullableOptional

presence_penaltynumber · nullableOptional

frequency_penaltynumber · nullableOptional

input_userstring · nullableOptional

422

Validation Error

application/json

get/chat/completions/{completion_id}

GET /chat/completions/{completion_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
}

Update Chat Completion

post

/chat/completions/{completion_id}

Update metadata for a chat completion

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

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

idstringOptional

objectstringOptionalDefault: chat.completion

createdintegerOptional

modelstringRequired

system_fingerprintstring · nullableOptional

service_tierstring · nullableOptional

request_idstring · nullableOptional

seedinteger · nullableOptional

top_pnumber · nullableOptional

temperaturenumber · nullableOptional

presence_penaltynumber · nullableOptional

frequency_penaltynumber · nullableOptional

input_userstring · nullableOptional

422

Validation Error

application/json

post/chat/completions/{completion_id}

POST /chat/completions/{completion_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
}

Get Chat Completion Messages

get

/chat/completions/{completion_id}/messages

Get messages for a chat completion

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

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

afterstring · nullableOptional

Identifier for the last message from the previous pagination request

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

objectstringOptionalDefault: list

first_idstring · nullableOptional

last_idstring · nullableOptional

has_morebooleanOptionalDefault: false

422

Validation Error

application/json

get/chat/completions/{completion_id}/messages

GET /chat/completions/{completion_id}/messages HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
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

/chat/completions/{completion_id}

Delete a chat completion

Authorizations

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

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

idstringRequired

objectstringOptionalDefault: chat.completion.deleted

deletedbooleanOptionalDefault: true

422

Validation Error

application/json

delete/chat/completions/{completion_id}

DELETE /chat/completions/{completion_id} HTTP/1.1
Host: api.activeloop.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "object": "chat.completion.deleted",
  "deleted": true
}