Skip to main content
POST
Read Conversation

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"

encryption_code
string
required

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"

conversation_id
string
required

The conversation id from the inbox.

Example:

"1000000000000000001:3000000000000000003"

cursor
string

A seq_id (from a previous next_cursor) to page to older messages.

count
integer
default:50

Messages per page (default 50, max 200).

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

Decrypted messages.

status
boolean
Example:

true

data
object
error
string | null
Example:

null