/chat

POST

/chat

curl --request POST \
  --url https://example.com/api/v1/chat \
  --header 'Content-Type: application/json' \
  --data '{ "conversationId": "example", "message": "example" }'

Request Body ^required

Media type application/json

object

conversationId

string

message

required

string

>= 1 characters <= 8192 characters

Example ^generated

{
  "conversationId": "example",
  "message": "example"
}

Responses

200

Default Response

Media type application/json

object

conversationId

required

string

text

required

string

toolEvents

required

Array<object>

object

tool

required

string

input

required

object

key

additional properties

result

required

string

isError

boolean

Example ^generated

{
  "conversationId": "example",
  "text": "example",
  "toolEvents": [
    {
      "tool": "example",
      "input": {
        "additionalProperty": "example"
      },
      "result": "example",
      "isError": true
    }
  ]
}

404

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

409

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}