Developer resources
Find integration guides and the separate Chatbyte API reference.
The main Chatbyte guides explain how customers use the product. Use these resources when implementing an integration or adding Chatbyte to your own application.
Public API reference
The Chatbyte API reference is the dedicated reference for endpoints, authentication, request and response schemas, and webhooks. It covers voice resources, calls, tasks, tools, analytics, knowledge, and the Model API.
Use the OpenAPI document when generating a client or validating payloads. Keep server API tokens in your backend, separate from browser-side Widget configuration.
Embed the Widget
- Follow Spark and Widget integration to load the chat experience.
- Use the Frontend API to open, close, and control it from your application.
- Set up JWT identity if customers sign in to your product. The identity signing secret guide explains where to find the relevant secret.
For JavaScript-specific examples, see initializing the Widget and interacting with it.
Connect customer data
Start with Customer context to agree on the desired behavior with the person configuring the agent. The connection implementation guide explains how that setup maps to the conversation-initialization callback and where to find its contract.
Integrate Pages
- Private Page sign-in: connect your existing authentication to a hosted or embedded Page.
- Pages on a website subpath: serve a Page at an address such as your website’s support path.
Sync knowledge
The Knowledge API guide explains how to add sources from your own systems, publish them, and choose which voice agents use them.
Call language models
The Model API guide explains how to create a key and make an OpenAI-compatible request. Its model keys are separate from Widget identity secrets and other API credentials.