De API van Ultineo Reasoning
Voer de applicaties uit de catalogus uit vanuit je eigen software. De API spreekt JSON via HTTPS, authenticeert elke aanroep met een projectsleutel en beantwoordt elke aanroep in hetzelfde formaat.
Gebouwd rond apps, uitvoeringen en sleutels
- Apps
Maak een app op basis van een model, de invoervelden en de instructies, en bekijk, lees en bewerk daarna je apps.
- Uitvoeringen en quotum
Eén aanroep start een app met de invoer; een andere leest de uitvoering terug met het antwoord. Een overzicht toont de tokens die je in je factuurperiode nog over hebt.
- Sleutels
Projectsleutels met rechten, een optionele vervaldatum en een status die je kunt uitschakelen.
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
}Authenticatie en rechten
- Een bearer-sleutel
Stuur je projectsleutel bij elke aanroep mee in de Authorization-header, uitsluitend via HTTPS.
- Beperkt tot één project
Een sleutel is aan één project gekoppeld en kan nooit de gegevens van een ander project lezen of schrijven, welk verzoek er ook komt.
- Opgeslagen als hash
Alleen een hash van de sleutel wordt bewaard, dus een sleutel wordt maar één keer volledig getoond. Een verloren sleutel wordt vervangen, nooit hersteld.
Start een uitvoering en lees het antwoord
- Aanmaken
Noem de applicatie en geef één waarde per invoerveld, met als sleutel de veldnaam die de applicatie teruggeeft.
- Volgen
Uitvoeringen zijn asynchroon: lees de uitvoering opnieuw uit tot de status voltooid of mislukt is. Beide zijn definitief.
- Lezen
Een voltooide uitvoering bevat het antwoord, de duur en het aantal tokens voor invoer en uitvoer.
Eén vast formaat voor elk antwoord
- Altijd dezelfde drie velden
Elk antwoord bevat de statuscode, een korte titel en de respons, bij succes en bij een fout.
- Vaste meldingen
Foutmeldingen zijn vaste Engelse teksten die het ontbrekende recht of de geweigerde waarde noemen.
- Duidelijke abonnementslimieten
Een aanroep die niet onder het abonnement valt, of die het tegoed zou overschrijden, wordt geweigerd met een eigen statuscode.
Een sleutel krijgen
API-toegang zit in de betaalde abonnementen van Ultineo Reasoning. Zelf aanmelden kan nog niet: ons team opent je project en geeft je de eerste sleutel.
Koppel je software aan Ultineo Reasoning
Vertel ons wat je wilt automatiseren, dan openen wij je project en de API-sleutel ervan.
Vragen over de API
De betaalde abonnementen. Het gratis abonnement geeft toegang tot de applicaties, zonder de API.
Nee. De instructies zijn van de eigenaar van de applicatie. De API geeft de invoervelden terug, want die vult de aanroeper in.
Het aanmaken van een uitvoering antwoordt meteen met de nieuwe status. Lees de uitvoering opnieuw uit tot ze voltooid is om het antwoord te krijgen.
Ja. Elke sleutel heeft rechten en een optionele vervaldatum, en een sleutel kan nooit een andere sleutel maken met ruimere rechten dan de eigen rechten.