Askly
Developer platform

Build with Askly
in minutes

A REST API, real-time webhooks, and a drop-in widget. Embed AI support anywhere your customers are — with five lines of code.

View on npm
Quickstart

Five lines of code

Embed Askly via CDN, install it in your React app, or hit the REST API directly.

jsx
$ npm install @askly/widget
import { useEffect } from 'react';
import Askly from '@askly/widget';
export default function App() {
  useEffect(() => {
    Askly.init({
      /* widgetId from the portal's Widget setup screen */
      widgetId: "6a53f2c696879f2c28fcb905"
    });
  }, []);
  return null;
}
Reference

Configuration options

All parameters supported by the widget and SDK. Same names across CDN, npm, and REST.

Parameter
Type
Default
Description
widgetId
string
—
Required. Your widget ID from the portal's Widget setup screen.
orgServerRoute
string
api.askly.co.in
Backend override. Only needed for self-hosted or local development.
theme
string
'auto'
Visual theme. One of 'light', 'dark', 'auto'.
position
enum
'bottom-right'
Widget bubble position on the page.
primaryColor
string
'#2563eb'
Override the brand accent for the widget.
locale
string
'en'
BCP-47 locale code for UI strings.
user
object
null
Identify the current user — { id, email, name, attrs }.
onEscalate
function
noop
Fires when a conversation is escalated to your team.
autoOpen
boolean
false
Open the widget on load. Useful for help-center pages.
API

Endpoints you'll actually use

Send messages, list conversations, and feed the knowledge base. That's most of what you need.

POST/api/messages

Send a customer message to Askly. Returns the AI reply, confidence score, and citations from your knowledge base.

user_idchannelmessageorg_id
GET/api/conversations

List conversations with filters by user, channel, status, or date range. Pagination via cursor.

user_id?status?limit?cursor?
POST/api/ingest/file

Upload a document to your knowledge base. Async — returns a job ID for status polling.

filesdocument_typeproduct_id?
POST/api/ingest/url

Import a web page into your knowledge base. Async — returns a job ID for status polling.

urldocument_typeproduct_id?
Integration

From signup to production in 15 minutes

1

Configure domain

Whitelist your website domain under your organization settings.

2

Install widget

Add the script tag or React component. No hardcoded config required!

3

Upload knowledge

Drop in your docs, sitemaps, or FAQs.

4

Go live

Customers start chatting. You sip coffee.

Support

Need help integrating?

Our developer community is active and helpful. Ask on Discord for fast answers, or email us if you need deeper help.