Skip to content
General Augment Docs

Send Agent Message

POST
/api/v1/agent/message/send

Deliver one tenant-initiated outbound message through a General Augment channel.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Admin-Key
Any of:
string
X-Admin-API-Key
Any of:
string
X-Project-ID
Any of:
string

Request Body required

Section titled “Request Body required ”
AgentMessageSendRequest

Tenant-initiated outbound message delivery request.

object
channel
required
Channel
string
Allowed value: telegram
chat_id
required
Chat Id
string
>= 1 characters <= 100 characters
message
required
Message
string
>= 1 characters <= 4096 characters
parse_mode
Any of:
string
Allowed values: Markdown MarkdownV2 HTML
reply_markup
Any of:
object
key
additional properties
any
user_id
Any of:
string
>= 1 characters <= 200 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

AgentMessageSendResponse

Response returned after General Augment delivers a tenant-initiated message.

object
channel
required
Channel
string
Allowed value: telegram
chat_id
required
Chat Id
string
message_id
Any of:
string format: uuid
ok
required
Ok
boolean
provider_message_id
Any of:
string
provider_response
Provider Response
object
key
additional properties
any

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string