Create Chat (v1.0.0)

Create a new chat in the catalog system

Command POST Chat

Overview

The Create Chat endpoint enables users to initiate a new chat session with the system. This endpoint accepts a text prompt and returns a unique identifier for the chat session. It’s designed to facilitate interactive conversations and queries within the BookWorm platform.

Architecture

POST /api/v1/chats

Creates a new chat in the catalog system and returns the chat’s unique identifier.

Request Body

Example Usage

Terminal window
curl -X POST https://api.bookworm.com/api/v1/chats \
  -H "Content-Type: application/json" \
  -d '{
    "text": "What is the best selling book in BookWorm?"
  }'

Response

200 Ok

Returns the newly created chat’s GUID in the response body.

"123e4567-e89b-12d3-a456-426614174000"

API Version

This endpoint is available in API version 1.0.

text string
required

The prompt text for the chat