agents

Create Chat

POST

/api/agents/{company_name}/chats

Create Chat

curl --request POST \
  --url '/api/agents/{company_name}/chats' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "en",
  "template_id": "<string>",
  "title": "<string>"
}
'

{
  "created_by": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "history_count": 123,
  "id": "5eb7cf5a86d9755df3a6c593",
  "language": "en",
  "preview_model": {
    "description": "<string>",
    "labels": [],
    "name": "<string>",
    "steps": [
      {
        "description": "<string>",
        "duration": "<string>",
        "name": "<string>",
        "notices": [
          {
            "description": "",
            "icon": "warning/W001.png",
            "type": "danger"
          }
        ],
        "safety_equipment": [],
        "specialists": [],
        "tools": []
      }
    ]
  },
  "status": "ready",
  "template_id": "<string>",
  "title": "<string>"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_namestringrequired

Body

languageenum<string>required

App language when chat is created

Available options: en, de, fr, es, it, pt, nl, pl, cs, da, sv, fi, nb, et, lt, lv, sk, sl, bg, ru, uk, el, tr, hu, ja, ko, zh, id

template_idstring | null

ID of the template to modify for the chat

titlestring | null

Name of the chat

Response

Successful Response

created_bystringrequired

datestringrequired

history_countintegerrequired

idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

languageenum<string>required

Available options: en, de, fr, es, it, pt, nl, pl, cs, da, sv, fi, nb, et, lt, lv, sk, sl, bg, ru, uk, el, tr, hu, ja, ko, zh, id

preview_modelobject | string[] | null

Show child attributes

string[]

statusenum<string>required

Available options: ready, in_progress, failed

template_idstring | nullrequired

titlestring | nullrequired