Documentation

Ragtime developer documentation for teams integrating the platform into their own products and workflows.

Ragtime is a platform for building and deploying persona-driven AI assistants that can be embedded across websites, kiosks, and other touchpoints, grounded in your own content and connected to your systems.

This developer documentation collects the most relevant technical information to help you set up, integrate, and extend Ragtime efficiently. A full platform walkthrough is also planned and will be added as additional documentation.

New to Ragtime, or to retrieval-based AI? Start with How Ragtime Works — it explains assistants, libraries, chunks, embeddings, audience gating, and retrieval in plain language, and gives you the vocabulary the rest of these pages assume.

Choosing between Actions, Conversation Stages, and Workflows? Start with Choose the Right Builder. It explains which system owns what the assistant does, conversational routing, and durable server-side automation.

Automation and orchestration

• Actions let the assistant look things up, ask visitors for details, tell your website, and run when a chat starts or ends.
• Conversation Stages divide a conversation into focused modes with scoped instructions and actions.
• Page Events let your page tell the conversation what the visitor is doing.
• Operational Workflows run durable business processes from events, webhooks, APIs, or schedules.
• Zendesk Setup connects ticket replies and status updates to Operational Workflows.

The API surface

The developer docs cover the main API families Ragtime exposes today:

• Ingest API — push files or raw text into a library, including upsert semantics and bulk items.
• Knowledge Base API — query chunks directly, list available sources/topics, and read source content with the correct narrow scope.
• Audience Labels — restrict a library to specific groups and read/write that policy via the API.
• Distillation & Lenses — summarize a library or recipient materials into a distilled briefing and switch retrieval between raw and distilled modes.
• Campaigns & Recipients — create one-to-one chat links, enforce limits, and attach personalized instructions.
• Assistant Config API: manage assistant instructions and conversation stages as code.
• API Keys — issue project-scoped keys with the minimum permissions each integration needs.

If you are integrating Ragtime into a workflow rather than hand-editing it in the dashboard, these are the endpoint families you will most likely use first.