SWEO AI

Webhooks & REST API

S

Written by SWEO AI Team

Updated over 2 weeks ago

Tillgängliga API-endpoints

Alla endpoints kräver autentisering via x-api-key-header med din tenant API-nyckel (genereras under Inställningar → API).

EndpointMetodBeskrivning/api/chat/messagePOSTSkicka meddelande, få synkront AI-svar/api/chat/streamPOSTSkicka meddelande, få SSE-stream/api/copilotPOSTAI Copilot-åtgärder (summarize, translate, etc.)/api/simulatePOSTKör test-scenario (dry run)/api/embeddingsPOSTGenerera embeddings för text/api/knowledge/exportGETExportera kunskapsbas som JSON/api/knowledge/importPOSTImportera kunskapsbas från JSON/api/conversations/handoverPOSTEskalera konversation till mänsklig agent

API-exempel: Skicka meddelande

Synkront svar:

curl -X POST https://your-domain.com/api/chat/message \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-tenant-api-key" \
  -d '{
    "message": "Hur returnerar jag en vara?",
    "conversationId": "conv_abc123",
    "channel": "api"
  }'

Svar:

{
  "content": "För att returnera en vara, gå till...",
  "confidence": 0.92,
  "sources": [
    { "title": "Returpolicy", "sourceId": "src_456" }
  ],
  "conversationId": "conv_abc123"
}

SSE Streaming

För realtidssvar, använd streaming-endpointen. Svaret skickas som Server-Sent Events:

curl -N -X POST https://your-domain.com/api/chat/stream \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-tenant-api-key" \
  -d '{"message": "Vad kostar frakt?", "conversationId": "conv_789"}'

Event-typer som skickas:

EventBeskrivningDatadeltaTextfragment (token för token){"text": "Frakt"}doneSvaret är komplett{"confidence": 0.89, "sources": [...]}errorFel uppstod{"message": "Rate limit exceeded"}blockedPolicy blockerade svaret{"policy": "topic_filter", "reason": "..."}escalatedConfidence för låg, eskalerar{"reason": "low_confidence", "score": 0.45}

Inkommande webhooks

SWEO AI tar emot meddelanden från externa kanaler via webhooks:

WebhookKällaKonfiguration/api/webhooks/emailCloudMailin / SendGrid Inbound ParseStäll in forwarding-adress i din e-postleverantör/api/webhooks/whatsappTwilio WhatsAppAnge URL i Twilio Console → Messaging/api/webhooks/smsTwilio SMSAnge URL i Twilio Console → Phone Numbers

Alla inkommande webhooks valideras med provider-specifika signaturer för att förhindra förfalskning.

Utgående webhooks (Events)

Konfigurera utgående webhooks under Inställningar för att få notiser när saker händer i SWEO AI:

  • conversation.created — Ny konversation startad
  • conversation.resolved — Konversation löst av AI
  • conversation.escalated — Konversation eskalerad till agent
  • message.received — Nytt kundmeddelande
  • message.sent — AI eller agent skickade svar
  • knowledge.updated — Kunskapskälla uppdaterad

Payloaden skickas som JSON POST med en x-webhook-signature-header för verifiering.