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 einem Modell, ihren Eingabefeldern und ihren Anweisungen, und listen Sie Ihre Apps anschließend auf, rufen Sie sie ab und bearbeiten Sie sie.
- Läufe und Kontingent
Ein Aufruf startet eine App mit ihren Eingaben, ein weiterer ruft den Lauf mit seiner Antwort ab. Eine Übersicht zeigt die in Ihrem Abrechnungszeitraum verbleibenden Tokens.
- Schlüssel
Projektschlüssel mit Berechtigungsbereichen, optionalem Ablaufdatum und einem Status, den Sie deaktivieren können.
Integrate it anywhere
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- In your automations
A script or an automation tool launches a run at each event: a form received, a file dropped.
- From one answer to the next
The answer of one run can become a field of the next: your code chains the steps as it sees fit.
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.
What you send
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
}What you read back
{
"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.
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.
- Klare Tarifgrenzen
Ein Aufruf, den der Tarif nicht abdeckt oder der sein Kontingent überschreiten würde, wird mit einem eigenen Statuscode abgelehnt.
Einen Schlüssel erhalten
Der API-Zugang ist in den kostenpflichtigen Tarifen von Ultineo Reasoning enthalten. Eine Selbstregistrierung gibt es noch nicht: Unser Team richtet Ihr Projekt ein und übergibt Ihnen den ersten Schlüssel.
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
Die kostenpflichtigen Tarife. Der kostenlose Tarif bietet Zugang zu den Anwendungen, aber ohne API.
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.