Assistants — Overview

An Assistant is the AI brain that replies to customers on a single channel for one organization. The dashboard page /dashboard/models/[modelId] manages exactly this record. The API mirrors every field on that page so AI agents can configure assistants end-to-end without human onboarding.

Key rules

  • One channel → one assistant. A WhatsApp number, Instagram account, or Messenger page can be wired to at most one assistant. Connecting it to a new assistant automatically detaches it from the previous one.
  • One channel per platform per org.The Sendiee model assumes one WhatsApp account, one Instagram account, and one Messenger page per org. You don’t need to pass IDs — just { "channel": { "platform": "whatsapp", "activate": true } }.
  • Channel can be left disconnected. Omit channel (or pass activate: false) to create a draft assistant. Connect it later via PATCH /v2.0/assistants/:modelId.
  • All edits go to history. Every create / update / toggle / channel change writes a versioned snapshot tagged changedBy.source = "api" so the dashboard audit log surfaces API-driven changes alongside human edits.
  • Strict validation. Provider/model pairings, enum fields, and numeric ranges are validated locally. Failures return 422 ASSISTANT_VALIDATION_FAILED with a details[] array. Fetch supported values from GET /v2.0/assistants/options.

Endpoints

  • GET/v2.0/assistants/options
    Supported providers, models, voices
  • GET/v2.0/assistants
    List with filters
  • GET/v2.0/assistants/{modelId}
    Get one
  • POST/v2.0/assistants
    Create
  • PATCH/v2.0/assistants/{modelId}
    Partial update / channel activate
  • POST/v2.0/assistants/{modelId}/toggle
    Enable / disable
  • DELETE/v2.0/assistants/{modelId}
    Delete
  • GET/v2.0/assistants/{modelId}/history
    Edit history (last 10 versions)
  • POST/v2.0/assistants/{modelId}/restore
    Restore from history version