StipCore Agents API

Welcome to the StipCore Agents API documentation. This API provides HTTP and WebSocket endpoints for conversational AI agents: synchronous and streaming chat over REST, and real-time bidirectional communication over WebSockets.

Features

• REST Chat — POST /chat/run for synchronous responses and POST /chat/stream for Server-Sent Events (SSE) streaming.
• WebSocket — WS /ws for real-time messaging with support for both sync and streaming replies.
• JWT authentication — All endpoints require a valid JWT in the Authorization header.
• Conversation state — Conversations are cached in Redis and messages are persisted to the database.

Base URL

Use your deployment base URL (e.g. https://api.example.com) for all endpoints. The docs assume the API is mounted at the root.

Quick links

• Getting started — Authentication and first request
• Chat API — REST endpoints for run and stream
• WebSocket API — WebSocket events and message formats