# Chat Completions

## Create Chat Completion

> Create a chat completion with OpenAI-compatible format

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionRequest":{"properties":{"workspace":{"type":"string","title":"Workspace","default":"default"},"model":{"type":"string","title":"Model","default":"activeloop-l0"},"messages":{"items":{"$ref":"#/components/schemas/ChatMessage"},"type":"array","title":"Messages"},"temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Temperature","default":1},"top_p":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Top P","default":1},"n":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"N","default":1},"stream":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stream","default":false},"max_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Tokens"},"max_completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Completion Tokens"},"presence_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Presence Penalty","default":0},"frequency_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frequency Penalty","default":0},"logit_bias":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"null"}],"title":"Logit Bias"},"logprobs":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Logprobs","default":false},"top_logprobs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Top Logprobs"},"stop":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Stop"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed"},"response_format":{"anyOf":[{"$ref":"#/components/schemas/ResponseFormat"},{"type":"null"}]},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"},"stream_options":{"anyOf":[{"$ref":"#/components/schemas/StreamOptions"},{"type":"null"}]},"store":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Store","default":false},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"modalities":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Modalities"},"service_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Tier"},"reasoning_effort":{"anyOf":[{"type":"string","enum":["low","medium","high"]},{"type":"null"}],"title":"Reasoning Effort"}},"type":"object","required":["messages"],"title":"ChatCompletionRequest"},"ChatMessage":{"properties":{"role":{"type":"string","enum":["system","user","assistant","developer"],"title":"Role","default":"user"},"content":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/TextContentPart"},{"$ref":"#/components/schemas/FilterContentPart"}]},"type":"array"},{"type":"string"}],"title":"Content"}},"type":"object","required":["content"],"title":"ChatMessage"},"TextContentPart":{"properties":{"type":{"type":"string","const":"text","title":"Type","default":"text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"TextContentPart"},"FilterContentPart":{"properties":{"type":{"type":"string","const":"filter","title":"Type","default":"filter"},"filter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter"},"top_k":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Top K"},"file_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"File Ids"}},"type":"object","title":"FilterContentPart"},"ResponseFormat":{"properties":{"type":{"type":"string","title":"Type"}},"type":"object","required":["type"],"title":"ResponseFormat"},"StreamOptions":{"properties":{"include_usage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Usage"}},"type":"object","title":"StreamOptions"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions":{"post":{"summary":"Create Chat Completion","description":"Create a chat completion with OpenAI-compatible format","operationId":"create_chat_completion_chat_completions_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get Chat Completion Messages

> Get messages for a chat completion

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionMessageList":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/ChatCompletionMessageObject"},"type":"array","title":"Data"},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Id"},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Id"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data"],"title":"ChatCompletionMessageList"},"ChatCompletionMessageObject":{"properties":{"id":{"type":"string","title":"Id"},"role":{"type":"string","enum":["system","user","assistant","developer"],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"content_parts":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Content Parts"}},"type":"object","required":["id","role"],"title":"ChatCompletionMessageObject"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions/{completion_id}/messages":{"get":{"summary":"Get Chat Completion Messages","description":"Get messages for a chat completion","operationId":"get_chat_completion_messages_chat_completions__completion_id__messages_get","parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the chat completion","title":"Completion Id"},"description":"The ID of the chat completion"},{"name":"workspace","in":"query","required":false,"schema":{"type":"string","description":"The ID of workspace to lookup chat completion messages in","default":"default","title":"Workspace"},"description":"The ID of workspace to lookup chat completion messages in"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier for the last message from the previous pagination request","title":"After"},"description":"Identifier for the last message from the previous pagination request"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of messages to retrieve","default":20,"title":"Limit"},"description":"Number of messages to retrieve"},{"name":"order","in":"query","required":false,"schema":{"type":"string","description":"Sort order for messages by timestamp","default":"asc","title":"Order"},"description":"Sort order for messages by timestamp"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionMessageList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## List Completions

> List stored Chat Completions

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionList":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/ChatCompletionObject"},"type":"array","title":"Data"},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Id"},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Id"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data"],"title":"ChatCompletionList"},"ChatCompletionObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"system_fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Fingerprint"},"choices":{"items":{"$ref":"#/components/schemas/ChatCompletionChoice"},"type":"array","title":"Choices"},"usage":{"$ref":"#/components/schemas/ChatCompletionUsage"},"perception_usage":{"anyOf":[{"$ref":"#/components/schemas/ChatCompletionUsage"},{"type":"null"}]},"service_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Tier"},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed"},"top_p":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Top P"},"temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Temperature"},"presence_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Presence Penalty"},"frequency_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frequency Penalty"},"input_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input User"},"tools":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Tools"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"response_format":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response Format"},"responses":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Responses"}},"type":"object","required":["model","choices","usage"],"title":"ChatCompletionObject"},"ChatCompletionChoice":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"$ref":"#/components/schemas/ChatCompletionMessage"},"finish_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finish Reason"},"logprobs":{"anyOf":[{"$ref":"#/components/schemas/LogProbs"},{"type":"null"}]},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["index","message"],"title":"ChatCompletionChoice"},"ChatCompletionMessage":{"properties":{"role":{"type":"string","enum":["system","user","assistant","developer"],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"reasoning_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning Content"},"refusal":{"anyOf":[{},{"type":"null"}],"title":"Refusal"},"annotations":{"items":{"$ref":"#/components/schemas/ChatMessageAnnotation"},"type":"array","title":"Annotations"}},"type":"object","required":["role"],"title":"ChatCompletionMessage"},"ChatMessageAnnotation":{"properties":{"type":{"type":"string","title":"Type"},"text":{"type":"string","title":"Text"},"start_index":{"type":"integer","title":"Start Index"},"end_index":{"type":"integer","title":"End Index"},"file_citation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"File Citation"},"file_path":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"File Path"}},"type":"object","required":["type","text","start_index","end_index"],"title":"ChatMessageAnnotation"},"LogProbs":{"properties":{"content":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Content"}},"type":"object","title":"LogProbs"},"ChatCompletionUsage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens"},"completion_tokens":{"type":"integer","title":"Completion Tokens"},"total_tokens":{"type":"integer","title":"Total Tokens"}},"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"title":"ChatCompletionUsage"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions":{"get":{"summary":"List Completions","description":"List stored Chat Completions","operationId":"list_completions_chat_completions_get","parameters":[{"name":"workspace","in":"query","required":false,"schema":{"type":"string","description":"The ID of workspace to lookup chat completions in","default":"default","title":"Workspace"},"description":"The ID of workspace to lookup chat completions in"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier for the last chat completion from the previous pagination request","title":"After"},"description":"Identifier for the last chat completion from the previous pagination request"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of Chat Completions to retrieve","default":20,"title":"Limit"},"description":"Number of Chat Completions to retrieve"},{"name":"order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order for Chat Completions by timestamp","default":"asc","title":"Order"},"description":"Sort order for Chat Completions by timestamp"},{"name":"model","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by model","title":"Model"},"description":"Filter by model"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get Chat Completion

> Get a stored chat completion

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"system_fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Fingerprint"},"choices":{"items":{"$ref":"#/components/schemas/ChatCompletionChoice"},"type":"array","title":"Choices"},"usage":{"$ref":"#/components/schemas/ChatCompletionUsage"},"perception_usage":{"anyOf":[{"$ref":"#/components/schemas/ChatCompletionUsage"},{"type":"null"}]},"service_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Tier"},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed"},"top_p":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Top P"},"temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Temperature"},"presence_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Presence Penalty"},"frequency_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frequency Penalty"},"input_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input User"},"tools":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Tools"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"response_format":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response Format"},"responses":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Responses"}},"type":"object","required":["model","choices","usage"],"title":"ChatCompletionObject"},"ChatCompletionChoice":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"$ref":"#/components/schemas/ChatCompletionMessage"},"finish_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finish Reason"},"logprobs":{"anyOf":[{"$ref":"#/components/schemas/LogProbs"},{"type":"null"}]},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["index","message"],"title":"ChatCompletionChoice"},"ChatCompletionMessage":{"properties":{"role":{"type":"string","enum":["system","user","assistant","developer"],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"reasoning_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning Content"},"refusal":{"anyOf":[{},{"type":"null"}],"title":"Refusal"},"annotations":{"items":{"$ref":"#/components/schemas/ChatMessageAnnotation"},"type":"array","title":"Annotations"}},"type":"object","required":["role"],"title":"ChatCompletionMessage"},"ChatMessageAnnotation":{"properties":{"type":{"type":"string","title":"Type"},"text":{"type":"string","title":"Text"},"start_index":{"type":"integer","title":"Start Index"},"end_index":{"type":"integer","title":"End Index"},"file_citation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"File Citation"},"file_path":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"File Path"}},"type":"object","required":["type","text","start_index","end_index"],"title":"ChatMessageAnnotation"},"LogProbs":{"properties":{"content":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Content"}},"type":"object","title":"LogProbs"},"ChatCompletionUsage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens"},"completion_tokens":{"type":"integer","title":"Completion Tokens"},"total_tokens":{"type":"integer","title":"Total Tokens"}},"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"title":"ChatCompletionUsage"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions/{completion_id}":{"get":{"summary":"Get Chat Completion","description":"Get a stored chat completion","operationId":"get_chat_completion_chat_completions__completion_id__get","parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the chat completion to retrieve","title":"Completion Id"},"description":"The ID of the chat completion to retrieve"},{"name":"workspace","in":"query","required":false,"schema":{"type":"string","description":"The ID of workspace to lookup chat completion in","default":"default","title":"Workspace"},"description":"The ID of workspace to lookup chat completion in"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Update Chat Completion

> Update metadata for a chat completion

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"system_fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Fingerprint"},"choices":{"items":{"$ref":"#/components/schemas/ChatCompletionChoice"},"type":"array","title":"Choices"},"usage":{"$ref":"#/components/schemas/ChatCompletionUsage"},"perception_usage":{"anyOf":[{"$ref":"#/components/schemas/ChatCompletionUsage"},{"type":"null"}]},"service_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Tier"},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed"},"top_p":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Top P"},"temperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Temperature"},"presence_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Presence Penalty"},"frequency_penalty":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frequency Penalty"},"input_user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input User"},"tools":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Tools"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"response_format":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response Format"},"responses":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Responses"}},"type":"object","required":["model","choices","usage"],"title":"ChatCompletionObject"},"ChatCompletionChoice":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"$ref":"#/components/schemas/ChatCompletionMessage"},"finish_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finish Reason"},"logprobs":{"anyOf":[{"$ref":"#/components/schemas/LogProbs"},{"type":"null"}]},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["index","message"],"title":"ChatCompletionChoice"},"ChatCompletionMessage":{"properties":{"role":{"type":"string","enum":["system","user","assistant","developer"],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"reasoning_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reasoning Content"},"refusal":{"anyOf":[{},{"type":"null"}],"title":"Refusal"},"annotations":{"items":{"$ref":"#/components/schemas/ChatMessageAnnotation"},"type":"array","title":"Annotations"}},"type":"object","required":["role"],"title":"ChatCompletionMessage"},"ChatMessageAnnotation":{"properties":{"type":{"type":"string","title":"Type"},"text":{"type":"string","title":"Text"},"start_index":{"type":"integer","title":"Start Index"},"end_index":{"type":"integer","title":"End Index"},"file_citation":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"File Citation"},"file_path":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"File Path"}},"type":"object","required":["type","text","start_index","end_index"],"title":"ChatMessageAnnotation"},"LogProbs":{"properties":{"content":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Content"}},"type":"object","title":"LogProbs"},"ChatCompletionUsage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens"},"completion_tokens":{"type":"integer","title":"Completion Tokens"},"total_tokens":{"type":"integer","title":"Total Tokens"}},"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"title":"ChatCompletionUsage"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions/{completion_id}":{"post":{"summary":"Update Chat Completion","description":"Update metadata for a chat completion","operationId":"update_chat_completion_chat_completions__completion_id__post","parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the chat completion to update","title":"Completion Id"},"description":"The ID of the chat completion to update"},{"name":"workspace","in":"query","required":false,"schema":{"type":"string","description":"The ID of workspace to update chat completion in","default":"default","title":"Workspace"},"description":"The ID of workspace to update chat completion in"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Metadata"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get Chat Completion Messages

> Get messages for a chat completion

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionMessageList":{"properties":{"object":{"type":"string","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/ChatCompletionMessageObject"},"type":"array","title":"Data"},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Id"},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Id"},"has_more":{"type":"boolean","title":"Has More","default":false}},"type":"object","required":["data"],"title":"ChatCompletionMessageList"},"ChatCompletionMessageObject":{"properties":{"id":{"type":"string","title":"Id"},"role":{"type":"string","enum":["system","user","assistant","developer"],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"content_parts":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Content Parts"}},"type":"object","required":["id","role"],"title":"ChatCompletionMessageObject"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions/{completion_id}/messages":{"get":{"summary":"Get Chat Completion Messages","description":"Get messages for a chat completion","operationId":"get_chat_completion_messages_chat_completions__completion_id__messages_get","parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the chat completion","title":"Completion Id"},"description":"The ID of the chat completion"},{"name":"workspace","in":"query","required":false,"schema":{"type":"string","description":"The ID of workspace to lookup chat completion messages in","default":"default","title":"Workspace"},"description":"The ID of workspace to lookup chat completion messages in"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Identifier for the last message from the previous pagination request","title":"After"},"description":"Identifier for the last message from the previous pagination request"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of messages to retrieve","default":20,"title":"Limit"},"description":"Number of messages to retrieve"},{"name":"order","in":"query","required":false,"schema":{"type":"string","description":"Sort order for messages by timestamp","default":"asc","title":"Order"},"description":"Sort order for messages by timestamp"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionMessageList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Delete Chat Completion

> Delete a chat completion

```json
{"openapi":"3.1.0","info":{"title":"Activeloop Deep Research API","version":"1.0.0"},"servers":[{"url":"https://api.activeloop.ai","description":"Production server"},{"url":"https://api-beta.activeloop.dev","description":"Beta server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)"}},"schemas":{"ChatCompletionDeleted":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","title":"Object","default":"chat.completion.deleted"},"deleted":{"type":"boolean","title":"Deleted","default":true}},"type":"object","required":["id"],"title":"ChatCompletionDeleted"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/chat/completions/{completion_id}":{"delete":{"summary":"Delete Chat Completion","description":"Delete a chat completion","operationId":"delete_chat_completion_chat_completions__completion_id__delete","parameters":[{"name":"completion_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the chat completion to delete","title":"Completion Id"},"description":"The ID of the chat completion to delete"},{"name":"workspace","in":"query","required":false,"schema":{"type":"string","description":"The ID of workspace to delete chat completion in","default":"default","title":"Workspace"},"description":"The ID of workspace to delete chat completion in"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.activeloop.ai/api-reference/chat-completions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.