L'API di Ultineo Reasoning
Esegui le applicazioni del catalogo dal tuo software. L'API comunica in JSON su HTTPS, autentica ogni chiamata con una chiave di progetto e risponde a ogni chiamata con lo stesso formato.
Costruita intorno ad app, esecuzioni e chiavi
- App
Crea un'app a partire dai suoi campi di input e dalle sue istruzioni, poi elenca, leggi e modifica le tue app.
- Runs and usage
Una chiamata avvia un'app con i suoi input; un'altra rilegge l'esecuzione con la sua risposta. Un riepilogo mostra i token utilizzati nella settimana di fatturazione in corso e il relativo importo.
- Chiavi
Chiavi di progetto con permessi, una scadenza facoltativa e uno stato che puoi disattivare.
Integrarlo ovunque
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- Nelle tue automazioni
A script or an automation tool launches a run at each event: a form received, a file dropped.
- Da una risposta alla successiva
La risposta di una singola esecuzione può diventare un campo della successiva: il tuo codice catena i passaggi come meglio gli conviene.
The same run, through the API
Your software sends the application’s identifier and its fields, then reads the run back until it is finished.
Quelli che invii
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
} Quello che rileggi
{
"id": "runi_1b7f4e0c96a2d8531fca",
"object": "reasoning",
"status": "finished",
"response": { "miid_9a4c07e5b312df8641ca": "urgent" },
"tokens": { "input": 412, "output": 3, "total": 415 },
"duration": 1.84
} Autenticazione e permessi
- Una chiave bearer
Invia la chiave del progetto nell'header Authorization di ogni chiamata, solo tramite HTTPS.
- Limitata a un solo progetto
Una chiave è legata a un solo progetto e non può mai leggere né scrivere i dati di un altro progetto, qualunque sia la richiesta.
- Conservata come hash
Viene conservato solo un hash della chiave, quindi la chiave viene mostrata per intero una sola volta. Una chiave persa si sostituisce, non si recupera mai.
Avvia un'esecuzione e leggi la sua risposta
- Creare
Indica l'applicazione e fornisci un valore per ogni campo di input, identificato dal nome del campo restituito dall'applicazione.
- Seguire
Le esecuzioni sono asincrone: rileggi l'esecuzione finché il suo stato non è completata o non riuscita. Entrambi sono definitivi.
- Leggere
Un'esecuzione completata riporta la risposta, la durata e il numero di token in input e in output.
The runs your software started, one by one
Every call made through the API appears in the reasonings list, marked API, with its duration and its tokens. Each application shows the identifier your software calls.
Un unico formato per ogni risposta
- Sempre gli stessi tre campi
Ogni risposta riporta il codice di stato, un breve titolo e il contenuto, sia in caso di successo sia di errore.
- Messaggi stabili
I messaggi di errore sono stringhe stabili in inglese che indicano il permesso mancante o il valore rifiutato.
- Refusals are explicit
A call that cannot be accepted, for example while an invoice is overdue, is refused with its own status code.
Ottenere una chiave
API access is included with Ultineo Reasoning. There is no self-service sign-up: our team opens your project and hands you its first key.
Collega il tuo software a Ultineo Reasoning
Dicci cosa vuoi automatizzare e apriremo il tuo progetto e la sua chiave API.
Domande sull'API
Yes. Every project can call the API; a call is billed like any other run, on the tokens it uses.
No. Le istruzioni appartengono al proprietario dell'applicazione. L'API restituisce i campi di input, cioè ciò che compila chi effettua la chiamata.
La creazione di un'esecuzione risponde subito con il nuovo stato. Rileggi l'esecuzione finché non è completata per ottenere la risposta.
Sì. Ogni chiave ha dei permessi e una scadenza facoltativa, e una chiave non può mai creare un'altra chiave con permessi più ampi dei propri.