Autenticazione

Ogni richiesta viene autenticata con una chiave API emessa dal pannello del workspace, inviata come `Authorization: Bearer sk_live_...`.

Ogni chiave ha il proprio ambito di permessi configurabile — una chiave può essere limitata all'accesso in sola lettura, a risorse specifiche, oppure ricevere accesso completo in lettura e scrittura, indipendentemente da qualsiasi altra chiave emessa per lo stesso workspace.

Le chiavi vengono mostrate per intero una sola volta, nel momento in cui vengono create; da quel momento in poi solo il loro titolare può rivederle, e ogni chiave può essere revocata immediatamente dal pannello senza influire sulle altre.

Authorization: Bearer sk_live_...

Risorse

Ogni risorsa del modello dati sottostante è disponibile tramite l'API:

WorkspaceConfigurazione generale, lingua predefinita, canali attivi.
ContactCreazione, ricerca e consultazione dei clienti finali che scrivono.
ConversationElenco, creazione, chiusura e riassegnazione delle conversazioni.
MessageInvio e lettura dei messaggi all'interno di una conversazione.
DepartmentGestione dei team e delle loro regole di instradamento.
AgentGestione degli utenti umani, dei ruoli e dell'appartenenza ai reparti.
AIAgentCreazione e configurazione di agenti IA: istruzioni, base di conoscenza, strumenti richiamabili.
KnowledgeSourceCaricamento e gestione di documenti e URL per il RAG.
ChannelConfigurazione dei canali e delle loro credenziali.
WebhookIscrizione a eventi in uscita, firmati con HMAC.
APIKeyEmissione e revoca delle chiavi.

Eventi webhook

Iscrivi un `WebhookEndpoint` a uno qualsiasi di questi eventi; ogni consegna è firmata con HMAC usando il segreto associato a quell'endpoint, così puoi verificare che provenga davvero da noi prima di fidarti del suo contenuto:

conversation.createdÈ iniziata una nuova conversazione su un canale qualsiasi.
conversation.assignedUna conversazione è stata assegnata a un agente umano o a un reparto.
conversation.resolvedUna conversazione è stata chiusa, dall'IA o da un umano.
message.receivedÈ arrivato un nuovo messaggio in entrata da un contatto.
message.sentÈ stato inviato un messaggio a un contatto, dall'IA o da un agente.
handoff.requestedLa sicurezza dell'IA è scesa sotto la soglia del workspace e ha richiesto un umano.
ai_agent.tool_callUn agente IA ha invocato uno dei suoi strumenti configurati, inclusi strumenti che hai registrato tu stesso.

Le consegne vengono ritentate in caso di errore e non è garantita l'esattamente-una-volta — progetta il tuo gestore di webhook in modo che sia idempotente. La semantica completa di consegna e nuovi tentativi è documentata nei Termini API per Sviluppatori.

Streaming in tempo reale

Per le integrazioni che devono consumare eventi dal vivo invece che, o in aggiunta a, i webhook, ogni workspace espone un endpoint di streaming WebSocket:

wss://api.inteligenciaviva.com/v1/workspaces/{id}/stream

Limiti di frequenza e uso corretto

L'accesso all'API è soggetto a limiti di frequenza legati al piano del tuo workspace; una richiesta oltre il limite viene segnalata con HTTP 429 e gli header di limite di frequenza correnti, così puoi implementare correttamente un backoff. I limiti esatti e i termini pienamente vincolanti dell'uso dell'API — incluso cosa puoi e cosa non puoi fare con i dati che ottieni — sono stabiliti nei Termini API per Sviluppatori, collegati dalla pagina Legale.