API Overview

Synkora exposes a large API surface because it is a platform, not a single chat endpoint.

Main API Areas

• agents
• conversations and streaming chat
• knowledge bases and documents
• widgets
• messaging bot integrations
• OAuth and identity flows
• billing and usage
• monitoring and operational endpoints

Best Starting Point

For exact schemas and live request models, use the OpenAPI docs from a running instance:

http://localhost:5001/docs

This documentation focuses on the shape of the platform and how to think about the APIs, not on duplicating every generated schema by hand.

Authentication Patterns

Depending on the surface, calls may use:

• dashboard/session auth
• bearer tokens
• agent API keys
• widget API keys
• OAuth flows

Streaming

Interactive chat paths are streaming-first. When building API clients, assume incremental delivery is the normal mode for end-user experiences.

Related Pages

• Agents API
• Knowledge Bases API
• Billing and Usage API