Changelog

Assistants, with their tool grants, schedule, channel bindings and delegation policy.

• GET/api/v1/assistants
• POST/api/v1/assistants
• GET/api/v1/assistants/{id}
• PATCH/api/v1/assistants/{id}
• DELETE/api/v1/assistants/{id}

Granting tools to an assistant, with `enabled` resolved against each tool’s catalogue default — so the answer is what the assistant can do, not merely what was overridden.

• GET/api/v1/assistants/{id}/tools
• PUT/api/v1/assistants/{id}/tools

The tool catalogue, and the instruction library assistants draw their standing guidance from.

• GET/api/v1/tools
• GET/api/v1/instructions
• POST/api/v1/instructions
• GET/api/v1/instructions/{id}
• PATCH/api/v1/instructions/{id}
• DELETE/api/v1/instructions/{id}
• GET/api/v1/assistants/{id}/instructions
• PUT/api/v1/assistants/{id}/instructions

Memories — what an assistant has learned about the account, another assistant or one contact. Written on the natural key, so the same key twice updates rather than duplicates.

• GET/api/v1/memories
• POST/api/v1/memories
• DELETE/api/v1/memories/{id}

Triggers: what wakes an assistant on a schedule, on a CRM event, or when another system calls in. Preview resolves the audience and spends nothing; firing starts runs and does.

• GET/api/v1/triggers
• POST/api/v1/triggers
• GET/api/v1/triggers/{id}
• PATCH/api/v1/triggers/{id}
• DELETE/api/v1/triggers/{id}
• POST/api/v1/triggers/{id}/token
• POST/api/v1/triggers/{id}/preview
• POST/api/v1/triggers/{id}/run

Runs. Starting one returns 202 with a queued run — poll it, or subscribe to assistant.run_completed. The event feed is the whole timeline: every tick, message, tool decision and handoff.

• GET/api/v1/runs
• POST/api/v1/runs
• GET/api/v1/runs/{id}
• POST/api/v1/runs/{id}/cancel
• GET/api/v1/runs/{id}/events

Human approvals. A run that needs a decision parks until somebody answers or the timeout rule fires, and holds that conversation’s run slot while it waits.

• GET/api/v1/asks
• GET/api/v1/asks/{id}
• POST/api/v1/asks/{id}/answer

AI spend and the monthly budget, in billed figures that match the invoice.

• GET/api/v1/ai/usage
• GET/api/v1/ai/budget

Seven scopes: assistants:read and :write, runs:read and :start, asks:read and :answer, and ai:usage. A run bound to a contact can reply on your channels, so runs:start says so in its description.

Inquiries: submit an inquiry from your own form backend, list and filter the inbox, read one, move it through triage, delete it, and list or add internal notes.

• GET/api/v1/inquiries
• POST/api/v1/inquiries
• GET/api/v1/inquiries/{id}
• PATCH/api/v1/inquiries/{id}
• DELETE/api/v1/inquiries/{id}
• GET/api/v1/inquiries/{id}/notes
• POST/api/v1/inquiries/{id}/notes

Two scopes: inquiries:read and inquiries:write. As everywhere else, write implies read.

Two webhook events: inquiry.created, delivered as the submission arrives, and inquiry.status_changed.

GET /me — identify a key, its account, and the scopes it can exercise.

• GET/api/v1/me

Contacts: list, create, get and update contacts; add and remove tags; set custom-field values; list and add notes; list tags, create tags and list custom-field definitions.

• GET/api/v1/contacts
• POST/api/v1/contacts
• GET/api/v1/contacts/{id}
• PATCH/api/v1/contacts/{id}
• POST/api/v1/contacts/{id}/tags
• DELETE/api/v1/contacts/{id}/tags/{tag_id}
• PUT/api/v1/contacts/{id}/custom-fields
• GET/api/v1/contacts/{id}/notes
• POST/api/v1/contacts/{id}/notes
• GET/api/v1/tags
• POST/api/v1/tags
• GET/api/v1/custom-fields

Conversations: list and get threads, list their messages, change status or assignment, mark read, hand over to a human, return to the assistant, and list team members.

• GET/api/v1/conversations
• GET/api/v1/conversations/{id}
• GET/api/v1/conversations/{id}/messages
• PATCH/api/v1/conversations/{id}
• POST/api/v1/conversations/{id}/read
• POST/api/v1/conversations/{id}/takeover
• POST/api/v1/conversations/{id}/return-to-ai
• GET/api/v1/members

Messages: send a text, template or media message to a thread or a phone number, and read one message with its delivery status.

• POST/api/v1/messages
• GET/api/v1/messages/{id}

Templates: list and get approved WhatsApp message templates.

• GET/api/v1/templates
• GET/api/v1/templates/{id}

Broadcasts: create and send a template campaign, list and get campaigns, list per-recipient delivery, and cancel a scheduled one.

• POST/api/v1/broadcasts
• GET/api/v1/broadcasts
• GET/api/v1/broadcasts/{id}
• GET/api/v1/broadcasts/{id}/recipients
• POST/api/v1/broadcasts/{id}/cancel

Pipelines and deals: list pipelines with their stages; list, create, get, update, move, close, reopen and delete deals.

• GET/api/v1/pipelines
• GET/api/v1/deals
• POST/api/v1/deals
• GET/api/v1/deals/{id}
• PATCH/api/v1/deals/{id}
• POST/api/v1/deals/{id}/move
• POST/api/v1/deals/{id}/close
• POST/api/v1/deals/{id}/reopen
• DELETE/api/v1/deals/{id}

Webhooks: register HTTPS endpoints, subscribe them to events, rotate a signing secret, send a test ping, and inspect or redeliver individual deliveries.

• GET/api/v1/webhooks
• POST/api/v1/webhooks
• GET/api/v1/webhooks/{id}
• PATCH/api/v1/webhooks/{id}
• DELETE/api/v1/webhooks/{id}
• POST/api/v1/webhooks/{id}/rotate-secret
• POST/api/v1/webhooks/{id}/test
• GET/api/v1/webhooks/{id}/deliveries
• GET/api/v1/webhooks/{id}/deliveries/{delivery_id}
• POST/api/v1/webhooks/{id}/deliveries/{delivery_id}/redeliver

The OpenAPI 3.1 document at /api/v1/openapi.json, generated from the endpoint registry.