Die API von Ultineo AI
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 drei Ressourcen
- Katalog
Die veröffentlichten Anwendungen, die meistgenutzten zuerst, jeweils mit den erwarteten Eingabefeldern.
- Läufe
Ein Aufruf startet eine Anwendung mit ihren Eingaben, ein weiterer ruft den Lauf mit seiner Antwort ab.
- Schlüssel
Projektschlüssel mit Berechtigungsbereichen, optionalem Ablaufdatum und einem Status, den Sie deaktivieren können.
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 der Katalog 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 AI 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 AI
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.