Skip to main content

SDKs

Qefro ships two first-party packages plus ordinary HTTPS access to https://api.qefro.com:

PackageRole
@qefro-ai/widget / CDN widget.jsEmbeddable Customer AI on your website
@qefro-ai/backend / qefro-backend-sdk / qefro-backendOrganization backend framework — register Business Tool handlers and customer auth
Any HTTPS clientAdmin automation against REST + GraphQL

Short definition (citation-ready)

Customer chat embeds use @qefro-ai/widget. Organization backends that expose Business Tools use @qefro-ai/backend (TypeScript), qefro-backend-sdk (Rust), or qefro-backend (Python) over a signed webhook. Admin automation can also call https://api.qefro.com with a user JWT.

Website widget

ChannelEntry
npm@qefro-ai/widget
CDNhttps://cdn.qefro.com/widget.js

Typical capabilities (see package README / Admin Console snippet for current names):

  • open / close chat UI
  • setContext for page metadata
  • identify for end-user identity forwarding
  • auth token helpers for session updates

Platform: Website Widget, Identity Forwarding.

CDN embed

<script
src="https://cdn.qefro.com/widget.js"
data-token="YOUR_WIDGET_TOKEN"
data-endpoint="https://api.qefro.com"
data-workspace-id="YOUR_WORKSPACE_ID"
async>
</script>

Backend framework (Business Tools)

Install and register handlers, then connect the webhook in Admin Console and Sync Tools:

npm install @qefro-ai/backend
# or from crates.io:
cargo add qefro-backend-sdk
# or from PyPI:
pip install qefro-backend
# Cargo.toml
[dependencies]
qefro-backend-sdk = "1"

Guide: Register SDK Business Tools.
Reference: SDK Framework, Business Tools.
Examples: JS examples · Rust examples · Python examples · Examples index.

Protocol messages on your webhook: ping, tools.list, tool.invoke, tool.resume.

Server integrations (Admin API)

Use cURL, fetch, Python requests/httpx, etc.:

curl -sS -H "Authorization: Bearer $USER_JWT" \
https://api.qefro.com/api/v1/org/workspaces

More samples: Examples.

Workflow

Choose an integration style

  1. Customer chat on webCDN or npm widget.
  2. Business Tools in your backend@qefro-ai/backend + SDK Connection + Sync.
  3. Existing HTTPS APIsREST tools or OpenAPI import.
  4. Admin automationREST with Owner/Admin JWT.
  5. WhatsAppMeta webhooks — not the widget SDK.

FAQ

Is there an official Python SDK for Business Tools?
Yes — qefro-backend on PyPI (pip install qefro-backend) implements the same signed webhook protocol as @qefro-ai/backend (TypeScript) and qefro-backend-sdk (Rust). Admin REST can be called from any language.
Can I serve a local copy of the widget JS?
Prefer the CDN URL so you receive updates. If you pin a copy, you own freshness and security patches.
How do I register Business Tools from code?
Use app.tool(...) in @qefro-ai/backend, create an SDK Connection, then Sync Tools into a workspace. See Register SDK Business Tools.