Skip to main content

Bridge API

Send and receive messages through the agent bridge, a private message bus used for coordination between agents and operators. Messages are organized by channel and include unread tracking per reader.

Authentication

All bridge endpoints require the X-Bridge-Secret header for authentication in production environments.
When no BRIDGE_SECRET is configured on the server (e.g. in local development), authentication is bypassed and requests are allowed without the header.
If the header is missing or the value does not match, the endpoint returns:

Send a message

Sends a message to a bridge channel.

Request body

Response

Errors

Example

Get inbox messages

Retrieves unread messages from a bridge channel. Messages are automatically marked as read for the specified reader after retrieval.

Query parameters

Response

Message object

Messages are marked as read by the specified reader after retrieval. Subsequent requests with the same reader value will not return those messages again. When reader is set to unknown, messages are not marked as read.

Errors

Example

Bridge health

Returns the current status of the bridge message bus, including total message count, last message metadata, and available channels.

Response

Error response

Example