API'et til Ultineo Reasoning
Kør katalogets applikationer fra din egen software. API'et taler JSON over HTTPS, autentificerer hvert kald med en projektnøgle og besvarer alle kald i samme format.
Bygget op om apps, kørsler og nøgler
- Apps
Opret en app ud fra en model, dens inputfelter og dens instruktioner, og vis, læs og redigér derefter dine apps.
- Kørsler og kvote
Ét kald starter en app med dens input; et andet læser kørslen tilbage med dens svar. En oversigt viser de tokens, der er tilbage i din faktureringsperiode.
- Nøgler
Projektnøgler med rettigheder, en valgfri udløbsdato og en status, du kan slå fra.
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
}Autentificering og rettigheder
- En bearer-nøgle
Send din projektnøgle i Authorization-headeren i hvert kald, kun over HTTPS.
- Begrænset til ét projekt
En nøgle er knyttet til ét projekt og kan aldrig læse eller skrive data i et andet projekt, uanset forespørgslen.
- Gemt som en hash
Kun en hash af nøglen gemmes, så en nøgle vises i sin helhed én gang. En mistet nøgle erstattes og gendannes aldrig.
Start en kørsel, og læs dens svar
- Opret
Angiv applikationen, og giv én værdi pr. inputfelt, angivet med det feltnavn, som applikationen returnerer.
- Følg
Kørsler er asynkrone: læs kørslen igen, indtil dens status er færdig eller mislykket. Begge er endelige.
- Læs
En færdig kørsel indeholder sit svar, sin varighed og sit tokenforbrug for input og output.
Ét fast format for alle svar
- Altid de samme tre felter
Hvert svar indeholder statuskoden, en kort titel og selve indholdet, både ved succes og ved fejl.
- Stabile meddelelser
Fejlmeddelelser er stabile engelske tekststrenge, der nævner den manglende rettighed eller den afviste værdi.
- Planens grænser er tydelige
Et kald, som planen ikke dækker, eller som ville overskride dens kvote, afvises med en særskilt statuskode.
Sådan får du en nøgle
API-adgang følger med de betalte Ultineo Reasoning-planer. Der er endnu ingen selvbetjent tilmelding: vores team opretter dit projekt og giver dig dets første nøgle.
Forbind din software med Ultineo Reasoning
Fortæl os, hvad du vil automatisere, så opretter vi dit projekt og dets API-nøgle.
Spørgsmål om API'et
De betalte planer. Gratisplanen giver adgang til applikationerne uden API'et.
Nej. Instruktionerne tilhører applikationens ejer. API'et returnerer inputfelterne, som er det, den der kalder API'et, udfylder.
Når du opretter en kørsel, svarer API'et straks med den nye status. Læs kørslen igen, indtil den er færdig, for at få svaret.
Ja. Hver nøgle har rettigheder og en valgfri udløbsdato, og en nøgle kan aldrig oprette en anden nøgle med bredere rettigheder end sine egne.