Die API von Ultineo Reasoning
Führen Sie die Anwendungen des Katalogs aus Ihrer eigenen Software aus. Die API spricht JSON über HTTPS, authentifiziert jeden Aufruf mit einem Projektschlüssel und beantwortet jeden Aufruf im selben Format.
Aufgebaut auf Apps, Läufen und Schlüsseln
- Apps
Erstellen Sie eine App aus ihren Eingabefeldern und ihren Anweisungen, und listen Sie Ihre Apps anschließend auf, rufen Sie sie ab und bearbeiten Sie sie.
- Runs and usage
Ein Aufruf startet eine App mit ihren Eingaben, ein weiterer ruft den Lauf mit seiner Antwort ab. Eine Übersicht zeigt die in der laufenden Abrechnungswoche verbrauchten Tokens und ihren Betrag.
- Schlüssel
Projektschlüssel mit Berechtigungsbereichen, optionalem Ablaufdatum und einem Status, den Sie deaktivieren können.
Jederwhere integrieren
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- In deinen Automatisierungen
A script or an automation tool launches a run at each event: a form received, a file dropped.
- Von einer Antwort zur nächsten
Das Ergebnis eines Laufes kann zum Feld des nächsten werden: Ihr Code verkettet die Schritte, wie er es für richtig hält.
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.
Was du sendest
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
} Das Sie zurückgelesen haben
{
"id": "runi_1b7f4e0c96a2d8531fca",
"object": "reasoning",
"status": "finished",
"response": { "miid_9a4c07e5b312df8641ca": "urgent" },
"tokens": { "input": 412, "output": 3, "total": 415 },
"duration": 1.84
} Authentifizierung und Berechtigungsbereiche
- Ein Bearer-Schlüssel
Senden Sie Ihren Projektschlüssel bei jedem Aufruf im Authorization-Header, ausschließlich über HTTPS.
- Auf ein Projekt beschränkt
Ein Schlüssel ist an ein Projekt gebunden und kann niemals Daten eines anderen Projekts lesen oder schreiben, egal welche Anfrage gestellt wird.
- Als Hash gespeichert
Gespeichert wird nur ein Hash des Schlüssels, daher wird ein Schlüssel nur einmal vollständig angezeigt. Ein verlorener Schlüssel wird ersetzt, nie wiederhergestellt.
Einen Lauf starten und seine Antwort lesen
- Anlegen
Nennen Sie die Anwendung und liefern Sie einen Wert pro Eingabefeld, benannt nach dem Feldnamen, den die Anwendung zurückgibt.
- Verfolgen
Läufe sind asynchron: Fragen Sie den Lauf erneut ab, bis sein Status abgeschlossen oder fehlgeschlagen ist. Beide Status sind endgültig.
- Auslesen
Ein abgeschlossener Lauf enthält seine Antwort, seine Dauer und seine Token-Zahlen für Eingabe und Ausgabe.
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.
Ein einheitliches Format für jede Antwort
- Immer dieselben drei Felder
Jede Antwort enthält den Statuscode, einen kurzen Titel und die Rückgabe, bei Erfolg wie bei Fehlern.
- Stabile Meldungen
Fehlermeldungen sind stabile englische Zeichenketten, die den fehlenden Berechtigungsbereich oder den abgelehnten Wert nennen.
- Refusals are explicit
A call that cannot be accepted, for example while an invoice is overdue, is refused with its own status code.
Einen Schlüssel erhalten
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.
Verbinden Sie Ihre Software mit Ultineo Reasoning
Sagen Sie uns, was Sie automatisieren möchten, und wir richten Ihr Projekt und seinen API-Schlüssel ein.
Fragen zur API
Yes. Every project can call the API; a call is billed like any other run, on the tokens it uses.
Nein. Die Anweisungen gehören dem Eigentümer der Anwendung. Die API liefert die Eingabefelder, denn diese füllt der Aufrufer aus.
Das Anlegen eines Laufs antwortet sofort mit dem neuen Status. Fragen Sie den Lauf erneut ab, bis er abgeschlossen ist, um die Antwort zu erhalten.
Ja. Jeder Schlüssel trägt Berechtigungsbereiche und ein optionales Ablaufdatum, und ein Schlüssel kann nie einen anderen Schlüssel mit weiterem Berechtigungsbereich als seinem eigenen erstellen.