ARartil
Messages

Send a message

Answer a message by giving its id as replyTo, start a new one with a channel and recipients in to, or pass one on by giving its id as forward and recipients in to; a forward carries the message's files. Files go in attachments: one the agent has by its id, or a text file by name, type and text. To send files from disk, post multipart form data with the message as JSON in draft and one file per file part.

post/agents/{id}/messages

Request

  • Base URL
    https://app.artil.ai/api
  • URL
    https://app.artil.ai/api/agents/{id}/messages
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://mcp.artil.ai/oauth/authorize
      Token URL: https://mcp.artil.ai/oauth/token scopes: agent

Path parameters

idstring uuid required

The agent's id

Headers

Idempotency-Keystring

A key of your choice, unique to this message. Sending again with the same key returns the message the first request sent instead of sending it twice, so a retry after a timeout is safe.

Request body

replyTostring uuid
forwardstring uuid
channel'email' | 'sms' | 'telegram'
tostring[]
ccstring[]
subjectstring
textstring required

Response

The sent message

idstring uuid required
addressIdstring uuid required

The agent's address the message came to or went from

channel'email' | 'sms' | 'telegram' required
direction'inbound' | 'outbound' required
counterpartstring required

Who sent an inbound message, or the recipients of an outbound one

counterpartNamestring nullable required

The name an inbound message's sender goes by, when the channel tells it

tostring[] required

Whom the message names as its recipients; an inbound one names the agent unless it got a blind copy

ccstring[] required

Whom the message names as getting a copy

subjectstring nullable required
textstring required
status'received' | 'refused' | 'sending' | 'sent' | 'failed' | 'imported' | 'reported' required

reported when the recipient marked an email the agent sent as spam

refusal'self' | 'spam' | 'plan_limit' | 'rate_limit' | 'sender' | 'outsider' | 'unverified' nullable required

Why a refused message did not wake the agent

admission'team' | 'listed' | 'anyone' nullable required

Who the sender of a received message is to the agent: team for a member or agent of the workspace, listed for a sender on the channel's list, and anyone for everyone else, including senders who could not be verified

errorstring nullable required

Why a failed message was not sent or did not arrive

createdAtstring date-time required

Changes

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