Conviro API · v1 · stable

Yapay zekâ destek ajanını 5 dakikada

Kendi bilgi tabanınızdan beslenen, ticket çözen, müşteri adayı yakalayan ve insana devreden bir REST API ve webhook seti — orchestration'ı siz kurmadan.

Yapmaya başla API referansı API anahtarı al

Base URL: api.conviro.io/v1
Auth: Bearer token
Yanıt: 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": "..." }
}

Hızlı başlangıç

İlk başarılı isteğiniz

Üç adım. Kopyala-yapıştır. Altmış saniye içinde gerçek bir AI yanıtı görürsünüz — veya kayıt olmadan terminalinizden hemen deneyin.

API anahtarı olmadan dene — hemen şimdi

IP başına 5 req/dk

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 anahtarı oluştur
Şuraya gidin: Ayarlar → API Anahtarları ve şu scope ile bir anahtar oluşturun: chat:write . Yalnızca bir kez gösterilir — secret manager'da saklayın.
API anahtarı al
2
Mesaj gönder
Bearer token ile /sessions/:id/messages'a POST. Mevcut session id'nizi kullanın veya önce POST /sessions ile yeni oluşturun.
3
Yanıtı işle
Şunları alırsınız: requestId, latencyMs, AI yanıtı, tespit edilen niyet, güven skoru ve önerilen eylemler. Düşük güvenli yanıtları insana yönlendirin.

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

Yanıt

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 ajan

POST /api/developers/demo

Simüle et

Merhaba 👋 Ben canlı bir demoyum. Bir hazır soruyu deneyin, yukarıdaki use-case'lere tıklayın veya kendi sorunuzu yazın.

greetingconf 1.00

API ne döndü

{
  "intent": "greeting",
  "confidence": 1,
  "model": "conviro-resolve-2",
  "message": {
    "role": "assistant",
    "content": "Merhaba 👋 Ben canlı bir demoyum. Bir hazır soruyu deneyin, yukarıdaki use-case'lere tıklayın veya kendi sorunuzu yazın."
  }
}

Demo uç noktası şu hızla sınırlı: 5 req/min per IP. Gerçek bir API anahtarı varsayılan olarak 60 rpm alır (yapılandırılabilir).

Kullanım alanları

Ekiplerin gerçekten kurduğu şeyler

Bir karta tıklayarak playground'da canlı çalıştırın — gerçek API yanıtını bir saniye içinde görürsünüz.

Referans

API yüzeyi

En çok kullanacağınız uç noktalar. Base URL: https://api.conviro.io/v1/api

Tam referans

Method	Path	Gerekli scope	Açıklama
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'lar

Kütüphaneler ve istemciler

Resmi SDK'ları aşamalı olarak gönderiyoruz. REST API küçük, kararlı ve sarmak kolay — beklemek zorunda değilsiniz.

Node.js / TypeScript

Resmi · yakında

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

PHP

Resmi · yakında

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

Python

Topluluk

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

Go, Ruby, C#

REST API'yi doğrudan kullan

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

Hatalar

Öngörülebilir hata şekilleri

Her 2xx olmayan yanıt aynı JSON zarfını kullanır. Destekle iletişime geçtiğinizde requestId değerini iletin.

Durum	Ad	Ne zaman olur
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.

Yanıt gövdesi

application/json

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

429'da Retry-After header'ına uyun. 5xx'te üstel geri çekilme ile en fazla üç kez tekrarlayın.

Webhooks

Gerçek zamanlı olaylar, doğrulanmış

Her teslimi HMAC-SHA256 ile imzalarız. Başarısız teslimler üstel geri çekilme ile üç kez tekrarlanır. Devre kesici sürekli başarısız uç noktaları 60s karantinaya alır.

Olaylar

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

İmzayı doğrula

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

Nasıl çalışır

Tek API çağrısı, eksiksiz pipeline

Mesajı gönderirsiniz — sınıflandırma, getirme, üretim ve yönlendirmeyi biz halleder. Sonraki adımı belirlemeniz için ihtiyacınız olan her şeyi tek bir yanıtta alırsınız.

Ziyaretçi
Mesaj gönderir
Sınıflandır
Niyet + güven
Bilgi
Bilgi tabanından getir
Yanıt Üret
Yanıt + önerilen eylemler
Devret (gerekirse)
Düşük güven → insan

Tipik gecikme: ~450ms p50
Hız limiti: Anahtar başına 60 rpm · ayarlanabilir
Tekrar güvenli: Idempotent tekrarlar · webhook geri çekilme

Hazır olduğunuzda

İlk API çağrınız 60 saniye uzakta

API anahtarı oluşturun, quick-start snippet'i kopyalayın, gerçek yanıtı görün. Ücretsiz katman geliştirip test etmenize yetecek çağrıyı içerir.

API anahtarı al Paneli aç

Yapay zekâ destek ajanını 5 dakikada

İlk başarılı isteğiniz

API anahtarı oluştur

Mesaj gönder

Yanıtı işle