Wdróż agenta wsparcia AI w 5 minut
REST API i webhooki do rozwiązywania zgłoszeń, pozyskiwania leadów i przekazywania do ludzi — wspierane przez twoją bazę wiedzy, bez budowania orkiestracji.
- Bazowy URL
- api.conviro.io/v1
- Auth
- Bearer token
- Odpowiedź
- JSON · p50 ~450ms
$ 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"
}Szybki start
Twoje pierwsze udane żądanie
Trzy kroki. Wklejalne. Zobaczysz prawdziwą odpowiedź AI w ciągu sześćdziesięciu sekund — albo pomiń rejestrację i wypróbuj z terminala teraz.
Wypróbuj bez klucza API — od razu
5 żąd./min na IPcurl -X POST https://conviro.io/api/developers/demo \
-H "Content-Type: application/json" \
-d '{"content": "I want to return my last order"}'- 1
Utwórz klucz API
Przejdź do Ustawienia → Klucze API i utwórz klucz z
Pobierz klucz APIchat:writezakresem. Jest pokazywany raz — zapisz w menedżerze sekretów. - 2
Wyślij wiadomość
POST do /sessions/:id/messages z tokenem Bearer. Użyj istniejącego session id lub utwórz za pomocą POST /sessions.
- 3
Obsłuż odpowiedź
Otrzymasz
messageIdoraz status „queued”. Odpowiedź AI powstaje asynchronicznie — zasubskrybuj webhook message.new albo odczytaj sesję przez 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?"}'Odpowiedź
{
"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).
Agent demo
POST /api/developers/demo
Symulowane demo — gotowe odpowiedzi i sztuczne opóźnienie; żaden model AI nie jest wywoływany. Prawdziwe API odpowiada asynchronicznie.
Cześć 👋 Jestem demem na żywo. Wypróbuj preset, kliknij use-case powyżej lub wpisz własny.
Co zwróciło API
{
"intent": "greeting",
"confidence": 1,
"model": "scripted-demo",
"message": {
"role": "assistant",
"content": "Cześć 👋 Jestem demem na żywo. Wypróbuj preset, kliknij use-case powyżej lub wpisz własny."
}
}Demo-endpoint ma limit 5 req/min per IP. Prawdziwy klucz API otrzymuje domyślnie 60 rpm (konfigurowalne).
Przypadki użycia
Co zespoły naprawdę budują
Kliknij dowolną kartę, aby uruchomić ją na żywo w playground — zobaczysz prawdziwą odpowiedź API w mniej niż sekundę.
Referencja
Powierzchnia API
Endpointy, których będziesz używać najczęściej. Bazowy URL: https://api.conviro.io/v1/api
| Metoda | Ścieżka | Wymagany scope | Opis |
|---|---|---|---|
| POST | /sessions | chat:write | Create a new chat session |
| GET | /sessions | chat:read | List sessions for incremental reconciliation (keyset cursor, metadata only — no transcripts) |
| GET | /sessions/:id/messages | chat:read | Paginated message history for a session (oldest first, keyset cursor) |
| GET | /sessions/:id | chat:read | Get session with last 50 messages |
| POST | /sessions/:id/messages | chat:write | Send a message and get AI response |
| POST | /sessions/:id/identify | chat:write | Identify the visitor in a session from your backend — no frontend change needed |
| 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 analytics summary |
| GET | /contacts | contacts:read | List contacts with pagination and filters |
| GET | /contacts/:id | contacts:read | Get single contact with stats |
| POST | /contacts | contacts:write | Create or find contact by email |
| PATCH | /contacts/:id | contacts:write | Update contact fields |
| GET | /lead-forms | chat:read or magento:module | List active lead forms |
| GET | /appointments/slots | appointments:read | Open booking slots for a chatbot (optionally one local date / service) |
| POST | /appointments | appointments:write | Book an appointment directly (trusted backend — no OTP) |
| GET | /appointments | appointments:read | List appointments (newest first) |
| DELETE | /appointments/:id | appointments:write | Cancel an appointment (also removes the calendar event) |
| GET | /webhooks | webhooks:write | List webhook subscriptions |
| POST | /webhooks | webhooks:write | Subscribe to an event (creates a webhook subscription) |
| DELETE | /webhooks/:id | webhooks:write | Unsubscribe (deletes a webhook subscription) |
| POST | /consent/whatsapp | consent:write | Record a WhatsApp marketing opt-in collected on your checkout or form, with the text shown |
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.SDK
Biblioteki i klienci
Wdrażamy oficjalne SDK etapowo. REST API jest małe, stabilne i łatwe do owinięcia — nie musisz czekać.
Node.js / TypeScript
Oficjalne · wkrótce// @conviro/sdk — in private beta. The REST API
// already works great with fetch/axios today.PHP
Oficjalne · wkrótce// composer require conviro/sdk — in private beta.
// Use the cURL example below in the meantime.Python
Społeczność# No official SDK yet — the REST API is small enough
# that plain `requests` or `httpx` works well.Go, Ruby, C#
Użyj REST API bezpośrednio// No SDK — any HTTP client works. The auth header
// is the only thing you need.Błędy
Przewidywalne formaty błędów
Każda odpowiedź inna niż 2xx używa tej samej koperty JSON. Dołącz requestId gdy kontaktujesz się ze wsparciem.
| Status | Nazwa | Kiedy występuje |
|---|---|---|
| 400 | Bad Request | The 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. |
| 400 | Bad 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. |
| 401 | Unauthorized | Missing or malformed Authorization header, or an invalid, revoked or expired key. Never retry: the credential will not become valid. |
| 403 | Forbidden | The 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. |
| 404 | Not Found | No 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. |
| 429 | Too Many Requests | Per-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. |
| 500 | Server Error | Something failed on our side. The message is always this fixed string — internal detail is logged, never returned. Retry with exponential backoff. |
Treść odpowiedzi
{
"statusCode": 401,
"error": "Unauthorized",
"message": "API key is missing or invalid.",
"requestId": "req_1H8z...",
"docsUrl": "https://conviro.io/developers#errors"
}Przy 429 przestrzegaj Retry-After . Przy 5xx ponów z wykładniczym backoffem do trzech prób.
Webhooki
Zdarzenia w czasie rzeczywistym, zweryfikowane
Każdą dostawę podpisujemy HMAC-SHA256. Nieudane dostawy są ponawiane trzy razy z wykładniczym backoffem. Wyłącznik obwodu izoluje wielokrotnie zawodzące endpointy na 60s.
Zdarzenia
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
{
"event": "session.closed",
"timestamp": "2026-04-14T10:22:03.412Z",
"data": {
"sessionId": "sess_3f2a...",
"chatbotId": "bot_123"
}
}Zweryfikuj podpis
// 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);
}Jak to działa
Jedno wywołanie API, pełny pipeline
Wysyłasz wiadomość — my obsługujemy klasyfikację, retrieval, generowanie i routing. Otrzymujesz jedną odpowiedź ze wszystkim, co potrzebne do podjęcia decyzji.
Odwiedzający
Wysyła wiadomość
Klasyfikuj
Intent + pewność
Wiedza
Pobierz z bazy wiedzy
Generuj
Odpowiedź + sugerowane akcje
Eskalacja (może)
Niska pewność → człowiek
- Typowe opóźnienie
- ~450ms p50
- Rate limit
- 60 rpm na klucz · konfigurowalne
- Bezpieczne ponowienia
- Idempotentne ponowienia · backoff webhooka
Gdy jesteś gotowy
Twoje pierwsze wywołanie API jest 60 sekund stąd
Utwórz klucz API, skopiuj snippet szybkiego startu, zobacz prawdziwą odpowiedź. Darmowy tier zawiera wystarczająco wywołań do budowania i testowania.