Conviro API · v1 · stabili

Paleiskite AI palaikymo agentą per 5 minutes

REST API ir webhook'ai, skirti sprendžiant užklausas, fiksuojant potencialius klientus ir perduodant pokalbį žmonėms — paremti jūsų pačių žinių baze, jums nekuriant orkestracijos.

Pradėti kurti API dokumentacija Gauti API raktą

Pagrindinis URL: api.conviro.io/v1
Autentifikacija: Bearer token
Atsakymas: 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": "..." }
}

Greitas startas

Jūsų pirmoji sėkminga užklausa

Trys žingsniai. Kopijuojami ir įklijuojami. Tikrą AI atsakymą pamatysite per šešiasdešimt sekundžių — arba visai praleiskite registraciją ir išbandykite jį iš savo terminalo dabar pat.

Išbandykite be API rakto — dabar pat

5 užklausos per minutę vienam IP

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

1
Sukurkite API raktą
Eikite į Nustatymai → API raktai ir sukurkite raktą su chat:write apimtimi. Jis parodomas vieną kartą — saugokite jį savo slaptažodžių tvarkyklėje.
Gauti API raktą
2
Išsiųskite žinutę
POST į /sessions/:id/messages su Bearer token. Naudokite esamą sesijos id arba pirma sukurkite jį su POST /sessions.
3
Apdorokite atsakymą
Gaunate atgal requestId, latencyMs, AI atsakymą, aptiktą ketinimą, patikimumo įvertinimą ir siūlomus veiksmus. Nukreipkite žemo patikimumo atsakymus žmogui.

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?"}'

Atsakymas

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

Demonstracinis agentas

POST /api/developers/demo

Imituoti

Sveiki 👋 Aš esu tiesioginė demonstracinė versija. Išbandykite nustatymą, spustelėkite naudojimo atvejį aukščiau arba įveskite savo.

greetingconf 1.00

Ką grąžino API

{
  "intent": "greeting",
  "confidence": 1,
  "model": "conviro-resolve-2",
  "message": {
    "role": "assistant",
    "content": "Sveiki 👋 Aš esu tiesioginė demonstracinė versija. Išbandykite nustatymą, spustelėkite naudojimo atvejį aukščiau arba įveskite savo."
  }
}

Demonstracinio galinio taško užklausų dažnis ribojamas iki 5 req/min per IP. Tikras API raktas pagal numatytuosius nustatymus gauna 60 užklausų per minutę (konfigūruojama).

Naudojimo atvejai

Ką komandos iš tikrųjų kuria

Spustelėkite bet kurią kortelę, kad paleistumėte ją tiesiogiai bandymų aikštelėje — tikrą API atsakymą pamatysite per sekundę.

Dokumentacija

API paviršius

Galiniai taškai, kuriuos naudosite dažniausiai. Pagrindinis URL: https://api.conviro.io/v1/api

Pilna dokumentacija

Metodas	Kelias	Reikalinga apimtis	Aprašymas
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

Bibliotekos ir klientai

Oficialius SDK pristatome etapais. REST API yra nedidelė, stabili ir lengvai apvelkama — laukti nereikia.

Node.js / TypeScript

Oficialus · netrukus

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

PHP

Oficialus · netrukus

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

Python

Bendruomenė

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

Go, Ruby, C#

Naudokite REST API tiesiogiai

// 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.

Klaidos

Nuspėjamos klaidų formos

Kiekvienas ne 2xx atsakymas naudoja tą patį JSON vokelį. Įtraukite requestId kai kreipiatės į palaikymą.

Būsena	Pavadinimas	Kada tai įvyksta
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.

Atsakymo turinys

application/json

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

Esant 429, atsižvelkite į Retry-After antraštę. Esant 5xx, kartokite su eksponentiniu atidėjimu iki trijų bandymų.

Webhook'ai

Realaus laiko įvykiai, patikrinti

Kiekvieną pristatymą pasirašome HMAC-SHA256. Nepavykę pristatymai kartojami tris kartus su eksponentiniu atidėjimu. Grandinės pertraukiklis 60 sek. izoliuoja nuolat sutrikstančius taškus.

Įvykiai

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

Naudingoji apkrova

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
  }
}

Patikrinkite parašą

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();
}

Kaip tai veikia

Vienas API iškvietimas, visas konvejeris

Jūs paskelbiate žinutę — mes pasirūpiname klasifikavimu, paieška, generavimu ir nukreipimu. Gaunate vieną atsakymą su viskuo, ko reikia nuspręsti, kas vyks toliau.

Lankytojas
Siunčia žinutę
Klasifikuoti
Ketinimas + patikimumas
Žinios
Gauti iš jūsų žinių bazės
Generuoti
Atsakymas + siūlomi veiksmai
Eskaluoti (galbūt)
Žemas patikimumas → žmogus

Tipinė delsa: ~450ms p50
Užklausų dažnio riba: 60 užklausų per minutę vienam raktui · konfigūruojama
Saugu kartoti: Idempotentiniai pakartojimai · webhook atidėjimas

Pasiruošę, kai tik jūs

Jūsų pirmasis API iškvietimas už 60 sekundžių

Sukurkite API raktą, nukopijuokite greito starto kodo fragmentą, pamatykite tikrą atsakymą. Nemokamas planas apima pakankamai iškvietimų kurti ir testuoti.

Gauti API raktą Atidaryti valdymo skydelį

Paleiskite AI palaikymo agentą per 5 minutes

Jūsų pirmoji sėkminga užklausa

Sukurkite API raktą

Išsiųskite žinutę

Apdorokite atsakymą