chats.sendMessage

POST

/v1/chats/{chatId}/messages

curl --request POST \
  --url https://example.com/v1/chats/example/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandKey": "example", "input": [ { "type": "message", "role": "user", "content": [ { "type": "input_text", "text": "example" } ] } ], "queue": true }'

Sends a message to a direct Chat, a task Chat or a live Chat. In a task Chat, the Bot reads it as a message from you. In a live Chat, the message waits until a Live session is open.

Authorizations

• token
• session

Parameters

Path Parameters

chatId

required

string

>= 1 characters

Request Body^required

Media typeapplication/json

object

commandKey

required

string

>= 1 characters <= 128 characters

input

required

Any of:

string

string

>= 1 characters

Array<object>

Array<object>

>= 1 items

object

type

string

Allowed values: message

role

required

string

Allowed values: user

content

required

Any of:

string

string

>= 1 characters

Array

Array

>= 1 items

Any of:

object

object

type

required

string

Allowed values: input_text

text

required

string

>= 1 characters

object

object

type

required

string

Allowed values: input_image

file_id

required

string

>= 1 characters <= 128 characters

object

object

type

required

string

Allowed values: input_file

file_id

required

string

>= 1 characters <= 128 characters

queue

boolean

Responses

202

Success

Media typeapplication/json

object

executionId

required

string

>= 1 characters <= 128 characters

commandKey

required

string

>= 1 characters <= 128 characters

sequence

required

integer

<= 9007199254740991

chat

required

string

turn

required

string

Example ^generated

{
  "executionId": "example",
  "commandKey": "example",
  "sequence": 1,
  "chat": "example",
  "turn": "example"
}

400

ChatModelInvalid | FileInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChatModelInvalid

reason

required

string

Allowed values: provider-not-found model-not-found unsupported-option missing

message

required

string

object

object

_tag

required

string

Allowed values: FileInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ChatModelInvalid",
  "reason": "provider-not-found"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionForbidden

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ChatNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ChatNotFound

chat

required

string

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | ChatConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

object

object

_tag

required

string

Allowed values: ChatConflict

message

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | ChatStorageUnavailable | ChatExecutionUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ChatStorageUnavailable

object

object

_tag

required

string

Allowed values: ChatExecutionUnavailable

chat

required

string

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}