Conviro API · v1 · stabil

Liefern Sie einen KI-Support-Agenten in 5 Minuten

Eine REST-API und Webhooks zum Lösen von Tickets, Erfassen von Leads und Übergeben an Menschen — unterstützt durch Ihre eigene Knowledge Base, ohne dass Sie die Orchestrierung selbst bauen müssen.

Loslegen API-Referenz API-Schlüssel holen

Basis-URL: api.conviro.io/v1
Auth: Bearer-Token
Antwort: 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": "..." }
}

Schnellstart

Ihre erste erfolgreiche Anfrage

Drei Schritte. Zum Kopieren. Sie sehen eine echte KI-Antwort innerhalb von sechzig Sekunden — oder überspringen Sie die Anmeldung und probieren Sie es sofort vom Terminal aus.

Ohne API-Schlüssel ausprobieren — jetzt sofort

5 Anfragen/Min. pro 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
API-Schlüssel erstellen
Gehen Sie zu Einstellungen → API-Schlüssel und erstellen Sie einen Schlüssel mit dem chat:write -Scope. Er wird nur einmal angezeigt — speichern Sie ihn in Ihrem Secret-Manager.
API-Schlüssel holen
2
Nachricht senden
POST an /sessions/:id/messages mit einem Bearer-Token. Verwenden Sie Ihre vorhandene Session-ID oder erstellen Sie zuerst eine mit POST /sessions.
3
Antwort verarbeiten
Sie erhalten requestId, latencyMs, die KI-Antwort, das erkannte Intent, einen Confidence-Score und vorgeschlagene Aktionen. Routen Sie Antworten mit niedriger Confidence an einen Menschen.

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

Antwort

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

Demo-Agent

POST /api/developers/demo

Simulieren

Hi 👋 Ich bin eine Live-Demo. Probieren Sie eine Voreinstellung, klicken Sie auf einen Use-Case oder tippen Sie selbst.

greetingconf 1.00

Was die API zurückgegeben hat

{
  "intent": "greeting",
  "confidence": 1,
  "model": "conviro-resolve-2",
  "message": {
    "role": "assistant",
    "content": "Hi 👋 Ich bin eine Live-Demo. Probieren Sie eine Voreinstellung, klicken Sie auf einen Use-Case oder tippen Sie selbst."
  }
}

Der Demo-Endpoint hat ein Rate-Limit von 5 req/min per IP. Ein echter API-Schlüssel erhält standardmäßig 60 rpm (konfigurierbar).

Use Cases

Was Teams tatsächlich bauen

Klicken Sie auf eine Karte, um sie live im Playground auszuführen — Sie sehen die echte API-Antwort innerhalb einer Sekunde.

Referenz

API-Oberfläche

Die Endpoints, die Sie am häufigsten verwenden werden. Basis-URL: https://api.conviro.io/v1/api

Vollständige Referenz

Methode	Pfad	Erforderlicher Scope	Beschreibung
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

SDKs

Bibliotheken & Clients

Wir veröffentlichen offizielle SDKs in Phasen. Die REST-API ist klein, stabil und einfach zu wrappen — Sie müssen nicht warten.

Node.js / TypeScript

Offiziell · bald verfügbar

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

PHP

Offiziell · bald verfügbar

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

Python

Community

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

Go, Ruby, C#

REST-API direkt verwenden

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

Fehler

Vorhersehbare Fehlerformate

Jede Nicht-2xx-Antwort verwendet denselben JSON-Umschlag. Geben Sie requestId an, wenn Sie den Support kontaktieren.

Status	Name	Wann es passiert
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.

Antwortkörper

application/json

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

Bei 429 respektieren Sie den Retry-After -Header. Bei 5xx mit exponentiellem Backoff bis zu drei Versuche wiederholen.

Webhooks

Echtzeit-Events, verifiziert

Wir signieren jede Zustellung mit HMAC-SHA256. Fehlgeschlagene Zustellungen werden mit exponentiellem Backoff dreimal wiederholt. Ein Circuit Breaker setzt wiederholt fehlschlagende Endpoints für 60s in Quarantäne.

Events

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

Payload

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

Signatur verifizieren

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

So funktioniert es

Ein API-Aufruf, eine komplette Pipeline

Sie posten eine Nachricht — wir übernehmen Klassifizierung, Retrieval, Generierung und Routing. Sie erhalten eine einzige Antwort mit allem, was Sie für die nächste Entscheidung brauchen.

Besucher
Sendet eine Nachricht
Klassifizieren
Intent + Confidence
Wissen
Aus Ihrer KB abrufen
Generieren
Antwort + vorgeschlagene Aktionen
Eskalieren (vielleicht)
Niedrige Confidence → Mensch

Typische Latenz: ~450ms p50
Rate-Limit: 60 rpm pro Schlüssel · konfigurierbar
Wiederholungssicher: Idempotente Wiederholungen · Webhook-Backoff

Wenn Sie bereit sind

Ihr erster API-Aufruf ist 60 Sekunden entfernt

API-Schlüssel erstellen, Schnellstart-Snippet kopieren, eine echte Antwort sehen. Der Free-Tier enthält genug Aufrufe zum Bauen und Testen.

API-Schlüssel holen Dashboard öffnen

Liefern Sie einen KI-Support-Agenten in 5 Minuten

Ihre erste erfolgreiche Anfrage

API-Schlüssel erstellen

Nachricht senden

Antwort verarbeiten