Esportare un agente come codice
L'esportazione come codice fornisce un esempio pronto di chiamata API per richiamare un agente da un sistema esterno. È il modo più rapido per avviare un'integrazione: il codice contiene già l'indirizzo delle API e l'identificativo dell'agente, e richiede solo una chiave API valida.
Prerequisiti
- Permesso di consultazione dell'agente.
- Una chiave API dell'organizzazione, creata in Impostazioni > API > Chiavi API (vedere Chiavi API).
Aprire l'esportazione
- Aprire Agenti > Nome agente.
- Selezionare Altre azioni > Esporta.
- Nella finestra Esporta come codice, scegliere il formato: cURL per la riga di comando, Python oppure TypeScript.
- Selezionare l'icona Copia accanto al codice: la conferma Copiato negli appunti indica che il testo è pronto da incollare.
- Selezionare Chiudi.
Il codice generato
In tutti e tre i formati il codice invia un messaggio di esempio all'agente con una richiesta POST all'endpoint di chat, all'indirizzo della console in uso. La chiave viaggia nell'header X-Api-Key e il corpo della richiesta indica l'identificativo dell'agente, il testo del messaggio e la scelta di ricevere la risposta in un'unica soluzione anziché in streaming. Il formato cURL, ad esempio, ha questa struttura:
curl -X POST "https://ai.askme.it/api/v2/chat" \
-H "X-Api-Key: <API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"agent_id": 42,
"message": "Ciao, come posso aiutarti?",
"stream": false
}'
La chiave API
Il codice non contiene mai una chiave reale: il segnaposto <API_KEY> va sostituito con una chiave valida dell'organizzazione. Le chiavi sono visibili solo al momento della creazione, quindi occorre conservarle in un luogo sicuro subito dopo averle generate. Per chi può gestire le chiavi e ha l'accesso API attivo per l'organizzazione, la nota sotto il codice include il collegamento Gestisci chiavi API.
Oltre l'esempio
L'esempio copre la chiamata più semplice. Le opzioni aggiuntive della richiesta, come la risposta in streaming, la prosecuzione di una conversazione esistente e i valori delle variabili del prompt, sono descritte in Endpoint: Agenti, Chat e Conversazioni e in Variabili del prompt.
Problemi comuni
| Problema | Causa probabile | Soluzione |
|---|---|---|
| La chiamata restituisce un errore di autenticazione | Segnaposto <API_KEY> non sostituito, oppure chiave revocata o scaduta | Inserire una chiave valida (vedere Chiavi API) |
| Il collegamento Gestisci chiavi API non compare | Manca il permesso di gestire le chiavi, oppure l'accesso API non è attivo per l'organizzazione | Chiedere all'amministratore |
| L'agente risponde in modo diverso rispetto all'anteprima | La configurazione è cambiata dopo la prova, oppure l'agente non è nello stato atteso | Verificare lo stato e l'ultima versione dell'agente (vedere Versioni e confronto) |