API-referens

Written by SWEO AI Team

Updated over 2 weeks ago

Autentisering

Alla API-anrop kräver en giltig API-nyckel i headern:

x-api-key: your-tenant-api-key

Generera API-nycklar under Settings → API Keys. Varje nyckel är bunden till en specifik tenant och kan inte användas för andra organisationer.

Rate limit: 60 requests/minut per API-nyckel (konfigurerbart för enterprise-planer).

Chat-endpoints

EndpointMetodParametrarSvar/api/chat/messagePOSTmessage (string), conversationId (string, optional), channel (string)JSON: content, confidence, sources[], conversationId/api/chat/streamPOSTSamma som ovanSSE-stream: delta, done, error, blocked, escalated/api/copilotPOSTaction (string), conversationId (string)JSON: result (action-specifikt innehåll)/api/simulatePOSTscenario (object med messages[]), tenantIdJSON: log[], metrics

Se Webhooks & REST API för detaljerade curl-exempel.

Knowledge-endpoints

EndpointMetodBeskrivning/api/knowledge/exportGETExportera hela kunskapsbasen som JSON (alla sources med chunks)/api/knowledge/importPOSTImportera kunskapsbas från JSON-fil (merge eller replace-läge)/api/embeddingsPOSTGenerera embeddings för godtycklig text (använder text-embedding-3-large)

Konversations-endpoints

EndpointMetodBeskrivning/api/conversations/handoverPOSTEskalera konversation till mänsklig agent. Params: conversationId, reason, assignTo (optional)

Webhook-endpoints för inkommande meddelanden:

EndpointKälla/api/webhooks/emailCloudMailin / SendGrid Inbound Parse/api/webhooks/whatsappTwilio WhatsApp/api/webhooks/smsTwilio SMS

Felkoder

HTTP StatusKodBeskrivning400invalid_requestSaknade eller ogiltiga parametrar401unauthorizedOgiltig eller saknad API-nyckel403forbiddenAPI-nyckeln har inte behörighet för denna endpoint404not_foundKonversation eller resurs hittades inte429rate_limitedRate limit överskriden (retry efter Retry-After-header)500internal_errorInternt fel — kontakta support om det upprepas