API:et för Ultineo Reasoning
Kör katalogens applikationer från din egen programvara. API:et talar JSON över HTTPS, autentiserar varje anrop med en projektnyckel och besvarar alla anrop i samma format.
Uppbyggt kring appar, körningar och nycklar
- Appar
Skapa en app utifrån dess inmatningsfält och dess instruktioner, och lista, läs och redigera sedan dina appar.
- Runs and usage
Ett anrop startar en app med dess indata; ett annat läser tillbaka körningen med dess svar. En sammanfattning visar hur många tokens du har använt under den aktuella faktureringsveckan och deras belopp.
- Nycklar
Projektnycklar med behörigheter, ett valfritt utgångsdatum och en status som du kan stänga av.
Integrera det var som helst
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- I dina automatiseringar
A script or an automation tool launches a run at each event: a form received, a file dropped.
- Från ett svar till nästa
Svaret från en körning kan bli ett fält i nästa: koden länkar stegen som den vill.
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.
Vad du skickar
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
} Vad du läser igen
{
"id": "runi_1b7f4e0c96a2d8531fca",
"object": "reasoning",
"status": "finished",
"response": { "miid_9a4c07e5b312df8641ca": "urgent" },
"tokens": { "input": 412, "output": 3, "total": 415 },
"duration": 1.84
} Autentisering och behörigheter
- En bearer-nyckel
Skicka din projektnyckel i Authorization-headern i varje anrop, endast över HTTPS.
- Begränsad till ett projekt
En nyckel är knuten till ett enda projekt och kan aldrig läsa eller skriva data i ett annat projekt, oavsett förfrågan.
- Sparad som en hash
Endast en hash av nyckeln sparas, så en nyckel visas i sin helhet en enda gång. En förlorad nyckel ersätts och återställs aldrig.
Starta en körning och läs dess svar
- Skapa
Ange applikationen och lämna ett värde per inmatningsfält, angivet med det fältnamn som applikationen returnerar.
- Följ
Körningar är asynkrona: läs körningen igen tills dess status är klar eller misslyckad. Båda är slutgiltiga.
- Läs
En klar körning innehåller sitt svar, sin varaktighet och sitt antal token för indata och utdata.
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.
Ett fast format för alla svar
- Alltid samma tre fält
Varje svar innehåller statuskoden, en kort titel och själva innehållet, både vid framgång och vid fel.
- Stabila meddelanden
Felmeddelanden är stabila engelska textsträngar som anger den saknade behörigheten eller det avvisade värdet.
- Refusals are explicit
A call that cannot be accepted, for example while an invoice is overdue, is refused with its own status code.
Så får du en nyckel
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.
Anslut din programvara till Ultineo Reasoning
Berätta vad du vill automatisera, så öppnar vi ditt projekt och dess API-nyckel.
Frågor om API:et
Yes. Every project can call the API; a call is billed like any other run, on the tokens it uses.
Nej. Instruktionerna tillhör applikationens ägare. API:et returnerar inmatningsfälten, som är det som den som anropar API:et fyller i.
När du skapar en körning svarar API:et direkt med den nya statusen. Läs körningen igen tills den är klar för att få svaret.
Ja. Varje nyckel har behörigheter och ett valfritt utgångsdatum, och en nyckel kan aldrig skapa en annan nyckel med bredare behörigheter än sina egna.