USusecreed
sanctum-chatbot

Chatbot Endpoint

Changed on
post/sanctum/api/chatbot

Request

Headers

x-user-idstring nullable

Request body

messagestring
conversation_idstring nullable
sendAudioboolean nullable
newUserboolean nullable
promptKeystring nullable

Used alongside daily topic quest

image_idsstring[] nullable
message_idstring uuid nullable
retriedFromStreamboolean nullable

Set by the client when re-sending a message whose streamed attempt failed. The stream route already saved the user message and counted the quota, so the buffered route must not do either again. Contract: the client sets this ONLY after receiving the stream's meta event — meta is emitted after the save/increment phase, so it is the signal that both actually happened. A stream that failed before meta (HTTP error, dropped connection) persisted nothing and must be retried WITHOUT this flag.

Response

Successful Response

replystring nullable
conversation_idstring required
bible_versesstring[]
errorstring nullable
audio_base64string nullable
message_idstring nullable
reply_idstring nullable

Changes

  • 789d848a2a2cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ec6a7aef1f3eRevision changes
    • info

      added the new optional request property