Conviro API · v1 · stabiilne

Juuruta AI-klienditoe agent 5 minutiga

REST API ja veebihaagid piletite lahendamiseks, müügivihjete kogumiseks ja inimestele üleandmiseks — toetatud sinu enda teadmusbaasi poolt, ilma et peaksid orkestratsiooni ise ehitama.

Alusta ehitamist API viitedokumentatsioon Hangi API-võti

Baas-URL: api.conviro.io/v1
Autentimine: Bearer-token
Vastus: JSON · p50 ~450ms

zsh — conviro

$ curl -s api.conviro.io/v1/api/sessions/sess_3f2a/messages \
  -H "Authorization: Bearer cvr_live_***" \
  -d '{"content":"How do I return an order?"}'

# 200 OK — 412ms
{
  "requestId": "req_1H8zKj9m2QrT",
  "latencyMs": 412,
  "intent": "refund.request",
  "confidence": 0.94,
  "model": "conviro-resolve-2",
  "message": { "content": "..." }
}

Kiirstart

Sinu esimene edukas päring

Kolm sammu. Kopeeritav ja kleebitav. Näed päris AI-vastust kuuekümne sekundi jooksul — või jäta registreerimine täiesti vahele ja proovi seda kohe oma terminalist.

Proovi ilma API-võtmeta — kohe

5 päringut/min IP kohta

curl -X POST https://conviro.io/api/developers/demo \
  -H "Content-Type: application/json" \
  -d '{"content": "I want to return my last order"}'

1
Loo API-võti
Mine jaotisse Seaded → API-võtmed ja loo võti, millel on chat:write ulatus. Seda näidatakse vaid korra — salvesta see oma saladusehaldurisse.
Hangi API-võti
2
Saada sõnum
Tee POST aadressile /sessions/:id/messages koos Bearer-tokeniga. Kasuta oma olemasolevat seansi id-d või loo esmalt uus käsuga POST /sessions.
3
Käsitle vastust
Saad tagasi requestId, latencyMs, AI-vastuse, tuvastatud kavatsuse, kindlusskoori ja soovitatud toimingud. Suuna madala kindlusega vastused inimesele.

curl -X POST https://api.conviro.io/v1/api/sessions/SESSION_ID/messages \
  -H "Authorization: Bearer cvr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Can I return an item I bought yesterday?"}'

Vastus

200 OK · application/json

{
  "requestId": "req_1H8zKj9m2QrT",
  "latencyMs": 412,
  "sessionId": "sess_3f2a9e4b",
  "intent": "refund.request",
  "confidence": 0.94,
  "model": "conviro-resolve-2",
  "message": {
    "id": "msg_a12b7c",
    "role": "assistant",
    "content": "Items bought in the last 30 days can be returned. I've started the return for you.",
    "createdAt": "2026-04-14T10:22:03.412Z"
  },
  "suggestedActions": [
    { "type": "create_ticket", "label": "Open return" }
  ]
}

Playground

Try it right now — no signup

Real HTTP requests to a rate-limited demo endpoint. Every response shows requestId, latencyMs, intent, and confidence.

Live endpoint

Demoagent

POST /api/developers/demo

Simuleeri

Tere 👋 Olen reaalajas demo. Proovi eelseadet, klõpsa ülal kasutusjuhul või kirjuta enda oma.

greetingconf 1.00

Mida API tagastas

{
  "intent": "greeting",
  "confidence": 1,
  "model": "conviro-resolve-2",
  "message": {
    "role": "assistant",
    "content": "Tere 👋 Olen reaalajas demo. Proovi eelseadet, klõpsa ülal kasutusjuhul või kirjuta enda oma."
  }
}

Demo lõpp-punkti päringusagedus on piiratud: 5 req/min per IP. Päris API-võti saab vaikimisi 60 päringut minutis (seadistatav).

Kasutusjuhud

Mida meeskonnad tegelikult ehitavad

Klõpsa mis tahes kaardil, et seda mänguväljakul reaalajas käivitada — näed päris API-vastust sekundi jooksul.

Viitedokumentatsioon

API-pind

Lõpp-punktid, mida kõige rohkem kasutad. Baas-URL: https://api.conviro.io/v1/api

Täielik viitedokumentatsioon

Meetod	Tee	Nõutav ulatus	Kirjeldus
POST	/sessions	`chat:write`	Create a new chat session
GET	/sessions/:id	`chat:read`	Retrieve a session with its messages
POST	/sessions/:id/messages	`chat:write`	Send a message and get AI response
POST	/knowledge	`kb:write`	Add a knowledge base item
DELETE	/knowledge/:id	`kb:write`	Delete a knowledge base item
GET	/analytics/summary	`analytics:read`	Get a workspace analytics summary
POST	/webhooks	`webhooks:write`	Register a webhook endpoint

chat:readRead sessions and messages

chat:writeCreate sessions and send messages

kb:readRead knowledge base items

kb:writeCreate and delete knowledge base items

analytics:readRead analytics data

webhooks:writeManage webhook endpoints

SDK-d

Teegid ja kliendid

Saadame ametlikke SDK-sid välja etappidena. REST API on väike, stabiilne ja lihtne ümber pakkida — sa ei pea ootama.

Node.js / TypeScript

Ametlik · varsti tulekul

// @conviro/sdk — in private beta. The REST API
// already works great with fetch/axios today.

PHP

Ametlik · varsti tulekul

// composer require conviro/sdk — in private beta.
// Use the cURL example below in the meantime.

Python

Kogukond

# No official SDK yet — the REST API is small enough
# that plain `requests` or `httpx` works well.

Go, Ruby, C#

Kasuta REST API-t otse

// No SDK — any HTTP client works. The auth header
// is the only thing you need.

Browse the cookbook WooCommerce pluginWorking snippets for embeds, webhooks, CRM bridges, and platform plugins.

Vead

Ennustatavad veakujud

Iga mitte-2xx vastus kasutab sama JSON-ümbrist. Lisa requestId kui võtad klienditoega ühendust.

Olek	Nimi	Millal see juhtub
400	Bad Request	The request body or parameters are invalid.
401	Unauthorized	Missing or invalid API key.
403	Forbidden	API key is valid but lacks the required scope.
404	Not Found	The requested resource does not exist.
429	Too Many Requests	Rate limit exceeded. Respect the Retry-After header.
500	Server Error	Something went wrong on our side. Retry with backoff.

Vastuse sisu

application/json

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "API key is missing or invalid.",
  "requestId": "req_1H8z...",
  "docsUrl": "https://conviro.io/developers#errors"
}

Vea 429 korral järgi Retry-After päist. Vea 5xx korral korda eksponentsiaalse taandumisega kuni kolm korda.

Veebihaagid

Reaalajas sündmused, verifitseeritud

Allkirjastame iga kohaletoimetuse HMAC-SHA256-ga. Ebaõnnestunud kohaletoimetused korratakse kolm korda eksponentsiaalse taandumisega. Kaitselüliti paneb korduvalt ebaõnnestuvad lõpp-punktid 60 sekundiks karantiini.

Sündmused

session.startedA new chat session is created
session.closedA chat session is closed
session.escalatedA session is handed off to a human agent
message.newA new message is sent in a session
lead.capturedA lead is captured from a chat
handoff.requestedA visitor requests a human agent
csat.submittedA CSAT rating is submitted
ticket.createdA support ticket is created
ticket.resolvedA support ticket is resolved
ai.failedAI response generation failed

Andmesisu

POST your-endpoint · application/json

{
  "event": "session.closed",
  "deliveryId": "whk_4T2u...",
  "timestamp": "2026-04-14T10:22:03.412Z",
  "data": {
    "sessionId": "sess_3f2a...",
    "chatbotId": "bot_123",
    "visitorId": "v_789",
    "csatScore": 5,
    "messageCount": 12
  }
}

Verifitseeri allkiri

node.js

// Node.js — HMAC verification
import crypto from 'crypto';

const signature = req.headers['x-webhook-signature'];
const body = JSON.stringify(req.body);

const expected = crypto
  .createHmac('sha256', process.env.WEBHOOK_SECRET)
  .update(body)
  .digest('hex');

if (signature !== expected) {
  return res.status(401).end();
}

Kuidas see toimib

Üks API-päring, terve töötluskonveier

Sina saadad sõnumi — meie hoolitseme liigitamise, otsingu, genereerimise ja suunamise eest. Saad tagasi ühe vastuse koos kõige vajalikuga, et otsustada, mis edasi saab.

Külastaja
Saadab sõnumi
Liigita
Kavatsus + kindlus
Teadmised
Toob teie KB-st
Genereeri
Vastus + soovitatud toimingud
Eskaleeri (võib-olla)
Madal kindlus → inimene

Tüüpiline viiteaeg: ~450ms p50
Päringusageduse piirang: 60 päringut minutis võtme kohta · seadistatav
Kordusproovikindel: Idempotentsed kordusproovid · veebihaagi taandumine

Valmis, kui sina oled

Esimene API-päring on 60 sekundi kaugusel

Loo API-võti, kopeeri kiirstardi katkend, näe päris vastust. Tasuta tase sisaldab piisavalt päringuid ehitamiseks ja testimiseks.

Hangi API-võti Ava juhtpaneel

Juuruta AI-klienditoe agent 5 minutiga

Sinu esimene edukas päring

Loo API-võti

Saada sõnum

Käsitle vastust