Documentation

Build with Crystol AI

Everything you need to integrate AI-powered conversations into your product. Comprehensive guides, API references, and SDKs.

⌘K

Getting Started

Get up and running with Crystol AI in minutes. Follow this quickstart guide to make your first API call.

quickstart.ts
import { CrystolAI } from '@crystol/sdk';

const client = new CrystolAI({
  apiKey: process.env.CRYSTOL_API_KEY,
});

// Create a new conversation
const conversation = await client.conversations.create({
  agentId: 'your-agent-id',
  channel: 'web',
});

// Send a message
const response = await conversation.sendMessage({
  content: 'Hello, I need help with my order',
});

console.log(response.message);

Installation

Install the Crystol AI SDK using your preferred package manager.

npm
npm install @crystol/sdk
yarn
yarn add @crystol/sdk
pnpm
pnpm add @crystol/sdk
bun
bun add @crystol/sdk

API Reference

Complete reference for all API endpoints and parameters.

GET/v1/conversations

List all conversations for the authenticated user.

POST/v1/conversations

Create a new conversation with an AI agent.

WS/v1/conversations/:id/stream

WebSocket endpoint for real-time message streaming.

SDKs & Libraries

Official SDKs for popular programming languages and frameworks.

JavaScript/TypeScript
v2.1.0stable
Python
v1.8.0stable
Ruby
v1.2.0stable
Go
v0.9.0beta
PHP
v1.0.0stable
Java
v0.5.0alpha

Need help getting started?

Our team is here to help you integrate Crystol AI into your product. Schedule a call with our solutions engineers.

Talk to an expert