botserver/docs/src/chapter-10-api

Chapter 10: REST API Reference

HTTP API endpoints for integrating with BotServer.

Base URL

http://localhost:8000/api/v1

Authentication

Authorization: Bearer <token>

Core Endpoints

Endpoint	Method	Description
/chat	POST	Send message, get response
/sessions	GET	List active sessions
/sessions/:id	GET	Get session details
/files	POST	Upload file
/files/:id	GET	Download file

Quick Example

curl -X POST http://localhost:8000/api/v1/chat \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello", "session_id": "abc123"}'

Response Format

{
  "success": true,
  "data": { ... },
  "error": null
}

Chapter Contents

• Files API - Upload/download
• Document Processing - Text extraction
• Users API - User management
• Groups API - Group management
• Conversations API - Chat sessions
• Calendar API - Scheduling
• Tasks API - Task management
• Storage API - Object storage
• Analytics API - Metrics
• Admin API - Administration
• AI API - LLM endpoints
• Example Integrations - Code samples

See Also

• API and Tooling - Tool definitions
• Authentication - Security