API-et til Ultineo Reasoning
Kjør katalogapplikasjonene fra din egen programvare. API-et snakker JSON over HTTPS, autentiserer hvert kall med en prosjektnøkkel og besvarer alle kall i samme format.
Bygget rundt apper, kjøringer og nøkler
- Apper
Opprett en app fra en modell med inndatafelt og instruksjoner, og list deretter opp, les og rediger appene dine.
- Kjøringer og kvote
Ett kall starter en app med inndataene; et annet leser kjøringen tilbake med svaret. En oversikt viser hvor mange tokens du har igjen i faktureringsperioden.
- Nøkler
Prosjektnøkler med tillatelser, en valgfri utløpsdato og en status du kan slå av.
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
}Autentisering og tillatelser
- En bearer-nøkkel
Send prosjektnøkkelen din i Authorization-headeren i hvert kall, kun over HTTPS.
- Avgrenset til ett prosjekt
En nøkkel er knyttet til ett prosjekt og kan aldri lese eller skrive data i et annet prosjekt, uansett forespørsel.
- Lagret som en hash
Bare en hash av nøkkelen lagres, så en nøkkel vises i sin helhet én gang. En tapt nøkkel erstattes og gjenopprettes aldri.
Start en kjøring og les svaret
- Opprett
Oppgi applikasjonen og gi én verdi per inndatafelt, angitt med feltnavnet som applikasjonen returnerer.
- Følg
Kjøringer er asynkrone: les kjøringen på nytt til statusen er ferdig eller mislykket. Begge er endelige.
- Les
En ferdig kjøring inneholder svaret, varigheten og tokenantallet for inndata og utdata.
Ett fast format for alle svar
- Alltid de samme tre feltene
Hvert svar inneholder statuskoden, en kort tittel og selve innholdet, både ved suksess og ved feil.
- Stabile meldinger
Feilmeldinger er stabile engelske tekststrenger som angir den manglende tillatelsen eller den avviste verdien.
- Plangrensene er tydelige
Et kall som planen ikke dekker, eller som ville overskride kvoten, avvises med en egen statuskode.
Slik får du en nøkkel
API-tilgang følger med de betalte Ultineo Reasoning-planene. Det finnes ennå ingen selvbetjent registrering: teamet vårt oppretter prosjektet ditt og gir deg den første nøkkelen til det.
Koble programvaren din til Ultineo Reasoning
Fortell oss hva du vil automatisere, så oppretter vi prosjektet ditt og API-nøkkelen til det.
Spørsmål om API-et
De betalte planene. Gratisplanen gir tilgang til applikasjonene uten API-et.
Nei. Instruksjonene tilhører eieren av applikasjonen. API-et returnerer inndatafeltene, som er det den som kaller API-et, fyller ut.
Når du oppretter en kjøring, svarer API-et straks med den nye statusen. Les kjøringen på nytt til den er ferdig, for å få svaret.
Ja. Hver nøkkel har tillatelser og en valgfri utløpsdato, og en nøkkel kan aldri opprette en annen nøkkel med bredere tillatelser enn sine egne.