Conversations (v5)

Send an ephemeral activity signal to a conversation

Broadcasts a transient status (typing, thinking, tool_call, searching, processing) to clients currently viewing the conversation. Nothing is persisted; senders should re-post every 1-2 seconds while the activity lasts and receivers expire via ttl_ms.

post/v5/conversations/{id}/signal

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v5/conversations/{id}/signal
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Path parameters

idstring required

Request body

signal_type'typing' | 'thinking' | 'tool_call' | 'searching' | 'processing' required

Kind of activity being signaled

bodystring

Optional display text, e.g. "Analyzing sentiment across 12 messages"

ttl_msnumber

Client-side expiry hint in milliseconds

message_idstring

Optional message this signal is about. Async agents process several messages in parallel, so a signal needs to be able to name one.

Changes

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