chats.sendBotMessage

POST

/v1/bots/{botId}/messages

const url = 'https://example.com/v1/bots/example/messages';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"commandKey":"example","input":[{"type":"message","role":"user","content":[{"type":"input_text","text":"example"}]}],"queue":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/bots/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 your Chat with this Bot. OpenBot makes the Chat the first time. When the Bot is free, the message starts a Turn at once. When the Bot works for you, it reads the message at its next step. You need bots.delegate on the Bot.

Authorizations

token
session

Parameters

Path Parameters

botId

required

string

>= 1 characters <= 128 characters

Request Body^required

application/json

object

commandKey

required

string

>= 1 characters <= 128 characters

input

required

Any of:

string
Array<object>

string

>= 1 characters

queue

boolean

Responses

202

Success

application/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 | BotInvalid | OrganizationRequired

application/json

Any of:

object

_tag

required

string

Allowed values: ChatModelInvalid

reason

required

string

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

message

required

string

Example

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

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ChatNotFound | BotNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

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

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}

chats.sendBotMessage

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

202

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required

Example ^generated