In breve
- Agenti, chat e contatti.Crei, legga, aggiorni ed elimini agenti, e legga conversazioni, messaggi e contatti.
- Chiavi con solo ciò che serve.Chiavi segrete per i suoi server, chiavi con limiti, ristrette ai permessi che spunta.
- OpenAPI 3.1 incluso.Una descrizione leggibile dalle macchine viene servita in tempo reale, generata dalle stesse regole che l'API controlla.
- Sicuro da ritentare.Invii una Idempotency-Key e una scrittura ritentata restituisce il primo risultato invece di essere eseguita due volte.
Un'API permette al suo software di parlare direttamente con OneType. Le agenzie configurano gli agenti per i clienti da uno script, i team di prodotto portano le conversazioni nei propri report e i team operativi tengono le impostazioni degli agenti nel codice. L'API REST le offre gli stessi dati e le stesse regole della dashboard, via semplice HTTPS.
Cosa può fare
- Agenti: elencare, creare, leggere, aggiornare ed eliminare, comprese istruzioni, modello, domini consentiti e domande suggerite.
- Conversazioni: elencarle per agente, stato o data di inizio, leggerne una e leggerne i messaggi.
- Contatti: elencare e leggere le persone che il suo agente ha incontrato.
- Chat: aprire una conversazione e ottenere la risposta dell'agente, in JSON o in streaming.
- Scaricare la descrizione OpenAPI 3.1 da /v1/openapi.json.
Ogni messaggio indica se è stato scritto dall'IA o dal suo team. Gli elenchi usano cursori, da 1 a 100 elementi per pagina, e restano stabili mentre arrivano nuovi elementi. Un aggiornamento può portare con sé la revisione che ha letto, così una modifica fatta da qualcun altro nel frattempo viene rifiutata invece di essere sovrascritta.
Chiavi API con limiti
Proprietari e amministratori creano le chiavi in “Developer”, “API keys”. Una chiave segreta può fare ciò che fa un amministratore del workspace, tranne gestire le chiavi e le azioni riservate ai proprietari. Una chiave con limiti ha solo i permessi che spunta, mai più dei suoi. Usi una chiave con limiti per ogni integrazione o script, così ciascuno può fare solo il proprio lavoro.
Una chiave viene mostrata una sola volta e conservata come hash. L'elenco mostra gli ultimi caratteri di ogni chiave e quando è stata usata l'ultima volta. Revochi una chiave e la richiesta successiva con essa fallisce. Le chiavi appartengono a un solo workspace e non possono mai leggere i dati di un altro.
Pensata per integrazioni reali
Ogni errore ha la stessa forma, con un codice stabile, un messaggio, dettagli sui campi dove servono e un ID di richiesta. Invii Idempotency-Key in una scrittura e il primo risultato viene conservato per 24 ore, così un nuovo tentativo dopo un timeout non crea mai un secondo agente né una seconda risposta.
Ogni chiave può fare 100 richieste e fino a 20 messaggi di chat ogni 10 secondi. Le intestazioni RateLimit mostrano quanto resta e un 429 indica quanto attendere. I limiti sono gli stessi in ogni piano a pagamento. Le richieste con una chiave sbagliata sono limitate per indirizzo di rete.
Cosa l'API non copre ancora
Fonti di conoscenza, utilizzo, webhook e integrazioni si gestiscono nella dashboard, non tramite l'API. I contatti sono di sola lettura. Le chiavi sono solo per i server: non esiste ancora una chiave per il browser. Oggi non c'è un SDK pubblicato su npm, quindi usi semplice HTTPS o generi un client dal file OpenAPI.
Il file OpenAPI è generato dagli stessi schemi che l'API usa per controllare le richieste, quindi non si discosta mai da ciò che il server accetta. L'API cambia solo aggiungendo cose: nuovi campi, nuovi endpoint e nuovi tipi di evento, quindi il codice che ignora i campi sconosciuti continua a funzionare.