API Reference

API Overview

Attachments

Download an attachment

GET/v1/attachments/{attachment}/content

Chats

Read what has happened: chats, the per-chat event sequence with no gaps in it, and mark-as-read with the typing indicator.

List chats

GET/v1/chats

Mark a chat read

POST/v1/chats/{chat}/read

Get a chat

GET/v1/chats/{chat}

ChatsEvents

Read what has happened: chats, the per-chat event sequence with no gaps in it, and mark-as-read with the typing indicator.

List a chat's events

GET/v1/chats/{chat}/events

ChatsMessages

Send a message into a chat. Content is the sealed parts union; delivery is asynchronous and reported on the chat’s event sequence.

Send a message in a chat

POST/v1/chats/{chat}/messages

Contract

The API serving its own contract: this OpenAPI document, and the part authority schemas.

Download the OpenAPI definition

GET/v1/openapi.yaml

Get a part type's JSON Schema

GET/v1/parts/{type}

Destination Messages

Send a message into a chat. Content is the sealed parts union; delivery is asynchronous and reported on the chat’s event sequence.

Send a message

POST/v1/messages

Event Log

Server-sent event streams — the same events the webhooks carry, held open instead of delivered.

List account events

GET/v1/event_log

Media

Upload durable media bytes before addressing them from a media part.

Upload media

POST/v1/media

Phone Numbers

The sending numbers behind your chats, with their live health: quality rating, messaging tier, and display-name status.

List phone numbers

GET/v1/phone_numbers

Streams

Server-sent event streams — the same events the webhooks carry, held open instead of delivered.

Stream events (SSE)

GET/v1/streams/events

Templates

Register message templates and read back the sendable ones with the parameters each takes — what a send outside the customer window needs, and what an agent is handed as tool schemas.

Register a template

POST/v1/templates

List templates

GET/v1/templates

Webhook Deliveries

Register where events are delivered, roll the signing secret without dropping a delivery, and see how the destination is behaving.

List webhook delivery history

GET/v1/webhook_deliveries

Webhook Endpoints

Register where events are delivered, roll the signing secret without dropping a delivery, and see how the destination is behaving.

Register a webhook endpoint

POST/v1/webhook_endpoints

Delete a webhook endpoint

DELETE/v1/webhook_endpoints/{endpoint}

List webhook endpoints

GET/v1/webhook_endpoints

Get a webhook endpoint

GET/v1/webhook_endpoints/{endpoint}

Update a webhook endpoint

PATCH/v1/webhook_endpoints/{endpoint}

Webhook EndpointsReplays

Register where events are delivered, roll the signing secret without dropping a delivery, and see how the destination is behaving.

Replay retained webhook events

POST/v1/webhook_endpoints/{endpoint}/replays

Get webhook replay status

GET/v1/webhook_endpoints/{endpoint}/replays/{replay}

Webhook EndpointsSecrets

Register where events are delivered, roll the signing secret without dropping a delivery, and see how the destination is behaving.