DeskClerk AI
Log in Start free
Product
Features Solutions Integrations Free Tools Compare Pricing
Company
Blog About Affiliate Help Center Contact
Log in Start free
Home / Features / Open API
Open API

Push your catalogue. Read the sync status.

A small, documented API for connecting your own systems — no SDK to learn.

Start free — 100 chats See pricing
POST /api/v1/integrations/sites/{siteId}/knowledge:batch
X-Integration-Api-Key: ***

{
  "idempotency_key": "sync-2026-10-20",
  "items": [
    {"external_source_key": "shipping",
     "title": "Shipping & delivery",
     "body_md": "We ship to Germany in 5–7 business days…"}
  ]
}
In short

The Open API lets your own systems push knowledge and read sync status. DeskClerk AI exposes a small REST surface scoped to one site, with idempotent writes and bounded batches, so an import is a predictable sequence rather than a spike.

  • Batch upsert up to 100 items
  • Idempotency keys
  • Per-site API key
  • Sync status endpoint
  • Independent rate limits
Endpoints

Three calls cover the integration

MethodPathPurpose
POST/integrations/sites/{siteId}/knowledge:batchUpsert up to 100 knowledge items
GET/integrations/sites/{siteId}/sync-statusCheck processed, pending and failed counts
DELETE/integrations/sites/{siteId}/knowledge/{sourceKey}Remove a source
Rules

Predictable by design

Idempotency

Every write takes an idempotency key; a retry does not duplicate work.

Bounded batches

Up to 100 items per request, so a large import is a sequence, not a spike.

Rate limits

Independent limits per key, with clear 429 responses.

The problem

Where it hurts today

Manual uploads

A large catalogue cannot be pasted by hand every week.

Unclear sync state

You cannot tell whether an item was processed or failed.

Duplicate imports

Retries create duplicate content.

Unbounded batches

One huge request times out and nothing is written.

Capabilities

What it does, in detail

Batch upsert

Push up to 100 knowledge items per request with a stable source key.

Idempotency

A retry with the same key does not duplicate work.

Sync status

Read processed, pending and failed counts for the site.

Delete a source

Remove a source by its key when it disappears upstream.

Scoped keys

Each key is bound to one site and can be revoked.

Rate limits

Independent limits per key with clear 429 responses.

Fit

Who it is for

E-commerce teams

Sync products and policies from a PIM or ERP.

B2B

Push price lists and datasheets on a schedule.

Platforms

Offer the assistant inside a larger product.

Agencies

Automate onboarding for many client sites.

Comparison

How it differs

CapabilityDeskClerk AIA generic chatbot
Batch knowledge upsertYes, 100 per requestOften manual UI
Idempotent retriesYesRare
Sync statusYesNo
Per-site scopingYesVaries
FAQ

Frequently asked questions

No SDK is required; the endpoint is plain HTTP with JSON.
With an integration API key scoped to a site, created in the workspace.
Up to 100 items per batch request.
The response reports each item; failed items can be retried with a new idempotency key.
The current API covers knowledge and sync status. Conversation export is available from the workspace.
No. You paste one script tag before the closing body tag of your site, or use a code block in your builder. Most sites are live in about 10 minutes.
PDF, DOCX, RTF, XLSX, XLS, CSV, PPTX, PPT, TXT, MD, HTML, JSON and XML — 11 format processors. Up to 50 MB per file and up to 200 pages per PDF. Scanned images are not supported.
It answers in the visitor's language, using your content. Interface text is available in English, Chinese, German and Arabic today; more interface languages are planned.
One visitor message or one assistant reply is one message. One question plus one answer is two messages, so plans are quoted in complete answers — 1,250 answers per month on Basic is 2,500 messages.
It says so, records the question as a knowledge gap, and can hand the conversation to your team. Handoff asks the visitor for contact details first.
Related

Keep reading

AI Chatbot

Answers visitor questions from your own content — and cites the source

Live Chat

Real-time chat with AI first, humans when needed — all in one inbox.

Chat Widget

A lightweight chat widget that matches your brand — free to start.

Knowledge Base

Feed it your website, PDFs and docs — it answers from them, with sourc

All features

The full capability list in one place

E-commerce

Answer product and shipping questions before checkout

B2B export

Qualify international buyers around the clock

Pricing

Plans, quotas and what is included

Open API in a real workspace

Open API is not a demo screen — it runs on the site you already have.

In practice

What it looks like on a normal Tuesday

A visitor asks the question you have answered a hundred times. The assistant replies from your content, shows the source, and captures the details when it matters.

  • REST API for conversations, leads and knowledge
  • Send leads to your CRM automatically
  • Trigger actions from chat events
  • Simple token-based authentication
A monitor showing a softly blurred dashboard
“It answers the way we would answer, because it only uses what we published.”
Operations manager · DeskClerk AI customer
Also included

The details that matter

By the numbers

The product behind this page

Only counts we can verify.

14
product features
4
interface languages
11
file formats
10
minutes to set up

Put an assistant on your website today

Start with 100 free chats. No credit card to begin, live in about 10 minutes.

Start free Talk to us first