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.

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

# 201 Created — the AI reply follows via the message.new webhook
{
  "messageId": "6d1f0c6e-3b7a-...",
  "role": "system",
  "content": "Message received. Preparing a response...",
  "status": "queued"
}

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

    Antwort verarbeiten

    Sie erhalten messageId und den Status „queued“. Die KI-Antwort wird asynchron erzeugt — abonnieren Sie den Webhook message.new oder lesen Sie die Sitzung mit GET /sessions/:id.

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

201 Created · application/json
{
  "messageId": "6d1f0c6e-3b7a-4f0e-9a52-8c1e2d4b7a90",
  "role": "system",
  "content": "Message received. Preparing a response...",
  "createdAt": "2026-04-14T10:22:03.412Z",
  "status": "queued"
}

Playground

Try it right now — no signup

Real HTTP requests to a rate-limited demo endpoint that returns scripted replies — no AI model is called, and the delay is artificial. The authenticated API answers asynchronously (see the quick start below).

Scripted demo

Demo-Agent

POST /api/developers/demo

Simulierte Demo — vorgefertigte Antworten und künstliche Latenz; es wird kein KI-Modell aufgerufen. Die echte API antwortet asynchron.

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": "scripted-demo",
  "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
MethodePfadErforderlicher Scope
POST/sessionschat:write
GET/sessionschat:read
GET/sessions/:id/messageschat:read
GET/sessions/:idchat:read
POST/sessions/:id/messageschat:write
POST/sessions/:id/identifychat:write
POST/knowledgekb:write
DELETE/knowledge/:idkb:write
GET/analytics/summaryanalytics:read
GET/contactscontacts:read
GET/contacts/:idcontacts:read
POST/contactscontacts:write
PATCH/contacts/:idcontacts:write
GET/lead-formschat:read or magento:module
GET/appointments/slotsappointments:read
POST/appointmentsappointments:write
GET/appointmentsappointments:read
DELETE/appointments/:idappointments:write
GET/webhookswebhooks:write
POST/webhookswebhooks:write
DELETE/webhooks/:idwebhooks:write
POST/consent/whatsappconsent:write
chat:readRead sessions and their messages, and list lead forms.
chat:writeCreate sessions, send messages, identify visitors.
kb:readRead knowledge base items. Minted, but required by no public operation today.
kb:writeCreate and delete knowledge base items, and drive the e-commerce sync endpoints.
analytics:readRead the workspace analytics summary.
webhooks:writeManage webhook subscriptions. Note this is required to LIST them as well as to change them — there is no webhooks:read scope, so a read-only integration still needs the write scope here.
contacts:readRead CRM contacts. Returns PII.
contacts:writeCreate and update CRM contacts — the records human agents work from.
leads:writeCreate a lead: drop a new inbound record at the top of the funnel. Deliberately narrower than contacts:write, so an automation posting form fills does not also get the power to rewrite existing people. Minted, but required by no public operation today.
appointments:readRead open slots and booked appointments.
appointments:writeBook and cancel appointments.
consent:writeRecord a WhatsApp marketing opt-in. Its own scope rather than riding on leads or contacts: a key that can post form fills should not also be able to assert that a person agreed to campaigns.
magento:moduleWhat the Conviro Magento module (1.4.0+) needs and nothing more: it registers its store, delivers the store event outbox, reads the admin stats cards and lists lead forms. It reads no conversation and writes no knowledge-base item through the public API. The module's browser-mediated connect mints a key with only this scope, limited to the chosen assistant.

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

StatusNameWann es passiert
400Bad RequestThe request was rejected by the handler. `message` is a single string. A 4xx may additionally carry `error`, `code`, `reason` or `state`: a machine-readable name, always one identifier (lower_snake or UPPER_SNAKE). Branch on that name when it is present, never on `message`; most errors carry none.
400Bad Request (validation)Body validation failed. Same status and same keys as bad_request, but `message` is an ARRAY of strings, one per failed constraint. Parse it as `string | string[]` or the most common 400 in the API will crash your error handler. Unknown fields also land here: the global pipe runs with forbidNonWhitelisted, so an undeclared field is a 400 rather than being ignored — except on the two contacts endpoints that bind no DTO class, where unknown fields pass through silently.
401UnauthorizedMissing or malformed Authorization header, or an invalid, revoked or expired key. Never retry: the credential will not become valid.
403ForbiddenThe key is valid but lacks the scope, or is restricted to assistants that do not include the one referenced. Scopes are evaluated with OR: holding ANY of the listed scopes is enough. Fix the key, do not retry.
404Not FoundNo such resource in your workspace. A resource that exists in another tenant is a 404 here, not a 403 — the tenant filter is applied before the lookup, so cross-tenant ids are indistinguishable from absent ones. That is deliberate.
429Too Many RequestsPer-key rate limit exceeded. THIS BODY IS DIFFERENT: it carries `retryAfter` and NO `timestamp`, because the guard writes it directly to the response and never reaches the global filter. A `Retry-After: 60` header is set. The separate plan-level limiter produces a 429 with a different message and no `retryAfter`. Retry after the header says, with backoff.
500Server ErrorSomething failed on our side. The message is always this fixed string — internal detail is logged, never returned. Retry with exponential 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

  • message.newA message was added to a session, by the visitor or by the assistant.
  • session.startedA new conversation session was created.
  • session.closedA session was closed.
  • session.escalatedA session was escalated to a human.
  • handoff.requestedA visitor asked for a human agent.
  • lead.capturedA lead was captured from a conversation.
  • lead.createdA lead record was created outside a chat — from an ad integration, a lead form, or an e-commerce order.
  • lead_form.submittedA lead form was submitted.
  • csat.submittedA CSAT rating was submitted.
  • csat.receivedThe same rating as csat.
  • ai.failedThe assistant could not produce an answer.
  • ticket.createdA support ticket was opened.
  • ticket.resolvedA support ticket was resolved.
  • contact.createdA CRM contact was created.
  • contact.updatedA CRM contact was updated.
  • contact.mergedTwo CRM contacts were merged.
  • contact.deletedA CRM contact was deleted.
  • appointment.bookedAn appointment was booked. Not listed in the dashboard event picker — subscribe with "*" or by name.
  • appointment.cancelledAn appointment was cancelled. Not listed in the dashboard event picker — subscribe with "*" or by name.
  • lead.hotA lead crossed the hot-lead threshold. Not listed in the dashboard event picker — subscribe with "*" or by name.
  • lead.updatedA lead record was corrected after capture. Not listed in the dashboard event picker — subscribe with "*" or by name.

Payload

POST your-endpoint · application/json
{
  "event": "session.closed",
  "timestamp": "2026-04-14T10:22:03.412Z",
  "data": {
    "sessionId": "sess_3f2a...",
    "chatbotId": "bot_123"
  }
}

Signatur verifizieren

node.js
// Node.js (Express) — verify a Conviro webhook
import crypto from 'crypto';

// The RAW body is required. express.json() parses and discards it, and
// JSON.stringify(req.body) does NOT reproduce the signed bytes — key
// order and whitespace both change the digest.
app.post('/conviro/webhook',
  express.raw({ type: 'application/json', limit: '1mb' }),
  (req, res) => {
    if (!verify(req.body, req.header('X-Webhook-Signature'))) {
      return res.status(401).end();
    }
    res.status(200).end();            // acknowledge within 10s
    void handle(JSON.parse(req.body.toString('utf8')));
  });

const TOLERANCE_SECONDS = 300;

function verify(rawBody, header) {
  if (!header) return false;

  // Header format: t=<unix_seconds>,v1=<hex_digest>
  const parts = new Map(header.split(',').map((p) => {
    const i = p.indexOf('=');
    return [p.slice(0, i).trim(), p.slice(i + 1).trim()];
  }));
  const timestamp = parts.get('t');
  const signature = parts.get('v1');
  if (!timestamp || !signature) return false;

  // Replay window: without it, a captured payload is valid forever.
  const age = Math.abs(Math.floor(Date.now() / 1000) - Number(timestamp));
  if (!Number.isFinite(age) || age > TOLERANCE_SECONDS) return false;

  // The digest covers "<timestamp>.<rawBody>" — NOT the body on its own.
  const expected = crypto
    .createHmac('sha256', process.env.CONVIRO_WEBHOOK_SECRET)
    .update(timestamp + '.')
    .update(rawBody)
    .digest('hex');

  const a = Buffer.from(signature, 'utf8');
  const b = Buffer.from(expected, 'utf8');
  // timingSafeEqual throws on a length mismatch, so check length first.
  return a.length === b.length && crypto.timingSafeEqual(a, b);
}

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.

  1. Besucher

    Sendet eine Nachricht

  2. Klassifizieren

    Intent + Confidence

  3. Wissen

    Aus Ihrer KB abrufen

  4. Generieren

    Antwort + vorgeschlagene Aktionen

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