Skip to main content
POST
Send Message

Authorizations

Authorization
string
header
required

Your OmniX API key, e.g. omnix_live_.... Billed per call.

Body

application/json
auth_token
string
required

The X account auth_token cookie the action runs as.

Example:

"YOUR_X_AUTH_TOKEN"

text
string
required

The message text.

Example:

"hello from the API"

conversation_id
string

An existing conversation (from the inbox). Provide this or user_id.

Example:

"1000000000000000001:2000000000000000002"

user_id
string

A numeric user id to start/reuse a 1-on-1. Provide this or conversation_id.

encryption_code
string

Your XChat encryption code — the PIN you set when enabling encrypted chats on X. Used to recover your key so messages can be decrypted and outgoing events signed.

Example:

"YOUR_XCHAT_PIN"

proxy
string

Optional outbound proxy for this call (http:// or https://, optionally user:pass@host:port). The X request runs through it — useful for geo-routing or spreading calls across IPs. SOCKS proxies are not supported.

Example:

"http://user:pass@host:8080"

Response

Sent.

status
boolean
Example:

true

data
object
error
string | null
Example:

null