POST /message/guest
application/json

Body Required

  • prompt string Required

    The user's chat message/prompt.

  • stream boolean

    Whether to receive the response as a stream (Server-Sent Events).

    Default value is false.

Responses

  • 200 application/json

    Chat response received (non-streaming)

    Hide response attributes Show response attributes object
    • success boolean Required
    • statusCode integer Required
    • message string Required
    • data object Required
      Hide data attribute Show data attribute object
      • response string Required

        The AI's response message.

  • 400 application/json

    Bad Request (e.g., missing prompt)

    Hide response attributes Show response attributes object
    • success boolean Required
    • statusCode integer Required
    • message string Required
  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • success boolean Required
    • statusCode integer Required
    • message string Required
  • 200_stream text/event-stream

    Chat response streamed successfully (SSE)

    Server-Sent Events stream. Final message is data: [DONE]\n\n.

POST /message/guest
curl \
 --request POST 'http://localhost:3000/api/v1/message/guest' \
 --header "Content-Type: application/json" \
 --data '{"prompt":"Tell me about ReferSpecs.","stream":false}'
Request example
{
  "prompt": "Tell me about ReferSpecs.",
  "stream": false
}
Response examples (200)
{
  "success": true,
  "statusCode": 200,
  "message": "string",
  "data": {
    "response": "string"
  }
}
Response examples (400)
{
  "success": false,
  "statusCode": 400,
  "message": "Error description"
}
Response examples (500)
{
  "success": false,
  "statusCode": 400,
  "message": "Error description"
}