Skip to main content
POST
/
sessions
/
{session_id}
/
chat
{
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  },
  "jobs": [],
  "docs": [],
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "choices": [
    {
      "index": 123,
      "finish_reason": "stop",
      "logprobs": {
        "content": [
          {
            "token": "<any>",
            "logprob": "<any>",
            "bytes": "<any>",
            "top_logprobs": "<any>"
          }
        ]
      },
      "tool_calls": [
        {
          "type": "function",
          "function": {
            "name": "<any>",
            "arguments": "<any>"
          },
          "integration": "<any>",
          "system": "<any>",
          "api_call": "<any>",
          "computer_20241022": {
            "action": "<any>",
            "text": "<any>",
            "coordinate": "<any>"
          },
          "text_editor_20241022": {
            "command": "<any>",
            "path": "<any>",
            "file_text": "<any>",
            "insert_line": "<any>",
            "new_str": "<any>",
            "old_str": "<any>",
            "view_range": "<any>"
          },
          "bash_20241022": {
            "command": "<any>",
            "restart": "<any>"
          },
          "id": "<string>"
        }
      ],
      "delta": {
        "role": "user",
        "tool_call_id": "<string>",
        "content": "<string>",
        "name": "<string>",
        "tool_calls": [
          {
            "type": "<string>",
            "function": {
              "name": "<any>",
              "arguments": "<any>"
            },
            "integration": "<any>",
            "system": "<any>",
            "api_call": "<any>",
            "computer_20241022": {
              "action": "<any>",
              "text": "<any>",
              "coordinate": "<any>"
            },
            "text_editor_20241022": {
              "command": "<any>",
              "path": "<any>",
              "file_text": "<any>",
              "insert_line": "<any>",
              "new_str": "<any>",
              "old_str": "<any>",
              "view_range": "<any>"
            },
            "bash_20241022": {
              "command": "<any>",
              "restart": "<any>"
            },
            "id": "<string>"
          }
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
X-Custom-Api-Key
string | null

Path Parameters

​
session_id
string<uuid>
required

Query Parameters

​
connection_pool
any

Body

application/json
​
messages
Message · object[]
required
Minimum length: 1
​
tools
CreateToolRequest · object[] | null
​
tool_choice
Available options:
auto,
none
​
recall
boolean
default:true
​
save
boolean
default:true
​
model
string | null
Maximum length: 120
​
stream
boolean
default:false
​
stop
string[]
Maximum length: 4
​
seed
integer | null
Required range: -1 <= x <= 1000
​
max_tokens
integer | null
Required range: x >= 1
​
logit_bias
object | null
​
response_format
object | null
  • SimpleCompletionResponseFormat
  • SchemaCompletionResponseFormat
​
agent
string<uuid> | null
​
repetition_penalty
number | null
Required range: 0 <= x <= 2
​
length_penalty
number | null
Required range: 0 <= x <= 2
​
min_p
number | null
Required range: 0 <= x <= 1
​
frequency_penalty
number | null
Required range: -2 <= x <= 2
​
presence_penalty
number | null
Required range: -2 <= x <= 2
​
temperature
number | null
Required range: 0 <= x <= 5
​
top_p
number | null
Required range: 0 <= x <= 1
​
metadata
object | null
​
auto_run_tools
boolean
default:false
​
recall_tools
boolean
default:true

Response

Successful Response

  • ChunkChatResponse
  • MessageChatResponse
​
created_at
string<date-time>
required
​
id
string<uuid>
required
​
choices
ChatOutputChunk · object[]
required
​
usage
object | null

Usage statistics for the completion request

​
jobs
string<uuid>[]
​
docs
DocReference · object[]
⌘I