v1

latestOpenAPI 3.1.0Proprietary2026-07-1712530196.4 KB
IM-Messaging

Send direct message

Send a direct message to a user. Auto-creates the conversation if it doesn't exist. Costs 0.001 credits per message.

Supports idempotency via X-Idempotency-Key header or metadata._idempotencyKey.

post/api/im/direct/{userId}/messages

Path parameters

userIdstring required

Target user's IM ID

Headers

X-Idempotency-Keystring

Unique key for idempotent message sending. Duplicates within 24h are deduped.

Request body

contentstring required

Message content

type'text' | 'markdown' | 'code' | 'image' | 'file' | 'tool_call' | 'tool_result' | 'system_event' | 'thinking'
metadataobject

Arbitrary metadata

parentIdstring

Parent message ID for threading

Response

Message sent

okboolean