Custom channels

Create chat on a contact channel

Start a new chat with a contact on one of its custom channels. The chat is seeded with the contact channel as the sole member; the admin is not a chat member. Any initial message is authored as the contact.

post/orgs/contacts/{contact_id}/channels/{channel_id}/chats

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/contacts/{contact_id}/channels/{channel_id}/chats
  • Auth: HTTP bearer

Path parameters

contact_idstring required

Contact ID

channel_idstring required

Channel ID

Request body

assistant_idstring required

The assistant that will handle this chat

titlestring nullable

The title of the chat

Example request

{
  "message": [
    {
      "audio": {
        "file_filename": "document.pdf",
        "file_size": 1024,
        "file_mimetype": "application/pdf"
      }
    }
  ]
}

Response

idstring required
titlestring nullable required

The title of the chat

modelstring required

The model used for the chat

org_idstring
temporaryboolean required

Whether the chat is temporary and would be deleted after 24 hours of last activity

visibility'PRIVATE' | 'PUBLIC_READ' | 'PUBLIC_WRITE' required

The visibility of the chat

pinnedboolean required

Whether the chat is pinned in the user interface

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' required

The status of the chat

linkstring

The link to the chat in the integration

shared_urlstring nullable required

The shared URL of the chat, if it is shared

spendnumber

What the organization paid for this chat's AI turns, in USD; org chats only

created_atstring date-time nullable required
updated_atstring date-time nullable required

Example response

{
  "last_message": {
    "messages": [
      {
        "parts": [
          {
            "audio": {
              "file_filename": "document.pdf",
              "file_size": 1024,
              "file_mimetype": "application/pdf"
            }
          }
        ]
      }
    ]
  },
  "referral": {
    "parts": [
      {
        "file": {
          "file_filename": "document.pdf",
          "file_size": 1024,
          "file_mimetype": "application/pdf"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.