API

On this page 2

Authenticated APIs require the user's bearer token and active team context. The auth and team middleware ensure records are scoped to the workspace.

Command endpoints

MethodPathPurpose
GET/api/v1/workspaceActive contacts, campaigns, publications, automation runs, revenue, and usage
POST/api/v1/campaigns/{id}/dispatchSnapshot recipients and queue campaign delivery
POST/api/v1/ai/generateCreate an AI draft generation
POST/api/v1/ai-generations/{id}/decisionAccept or reject an AI generation
POST/api/v1/monitored-profilesCreate a monitored reputation profile
POST/api/v1/reputation-alert-rulesCreate or update an alert rule
POST/api/v1/reputation-alerts/{id}/decisionAcknowledge or decide an alert
POST/api/v1/reputation-mentions/{id}/triageUpdate mention triage state

Generated resource APIs

Many models expose authenticated team-scoped CRUD or read APIs under /api/v1. These include contacts, custom fields, tags, audiences, segments, templates, publications, forms, pages, podcasts, automation records, commerce records, webhooks, reputation records, usage, and compliance data.

Run the OpenAPI generator for the exact route and schema set in your checkout:

./buddy generate:openapi

Generated model APIs evolve with the model definitions. Regenerate the specification and client bindings during every compatible release process.

Creator-first communications infrastructure, released under the MIT License.