/ Docs
API

Chat

Botyard REST API endpoints for chat.

7 endpoints in this group. Every request authenticates with an API key; see the API reference for the other groups.

  • Chat Send: POST /v1/orgs/{org_id}/conversations/{conversation_id}/chat
  • Chat Retry: POST /v1/orgs/{org_id}/conversations/{conversation_id}/chat/retry
  • Chat Wake: POST /v1/orgs/{org_id}/conversations/{conversation_id}/chat/wake
  • Chat Steer: POST /v1/orgs/{org_id}/conversations/{conversation_id}/chat/steer
  • Chat Cancel: POST /v1/orgs/{org_id}/conversations/{conversation_id}/chat/cancel
  • Chat Edit: POST /v1/orgs/{org_id}/conversations/{conversation_id}/chat/edit
  • Get Stream Event Schema: GET /v1/chat/stream-event-schema

Get Challenge

Issue a proof-of-work challenge for public form submissions. Returns a self-verifying HMAC-signed challenge that expires after ``altcha_challenge_expiry`` seconds.

Chat Send

Send a chat message; bot response arrives over Centrifugo. ``mode=steer`` injects the message into the active turn instead of queueing it behind one (no-op if no turn is active). Default ``queue`` preserves the prior ordering behaviour.