GRgrapesjs
AI

Start an AI chat stream

Starts a streaming AI chat session, used by AI chat plugin.

This endpoint is intended to be used with a short-lived access token created with /access-tokens for trusted client-side requests.

The response is a SSE stream in the AI SDK UI message format, consumed directly by the chat transport.

For more information about the AI chat plugin setup refer to this guide.

post/ai/chat

Request

  • Base URL
    https://api.grapesjs.com/v1
  • Auth
    HTTP bearer

Request body

idstring required

Chat session identifier.

messagesAiChatMessage[] required

Recent chat messages sent to the AI model.

projectContextAiChatProjectContext required

AI chat project context object forwarded by the client.

Response

Streaming response started successfully

Changes

No recorded changes to this operation across all 1 revision of this API.