La API de Ultineo Reasoning
Ejecute las aplicaciones del catálogo desde su propio software. La API habla JSON sobre HTTPS, autentica cada llamada con una clave de proyecto y responde a todas las llamadas con el mismo formato.
Construida en torno a aplicaciones, ejecuciones y claves
- Aplicaciones
Cree una aplicación a partir de un modelo, sus campos de entrada y sus instrucciones; después, liste, consulte y edite sus aplicaciones.
- Ejecuciones y cuota
Una llamada lanza una aplicación con sus entradas; otra consulta la ejecución con su respuesta. Un resumen muestra los tokens que le quedan en su ciclo de facturación.
- Claves
Claves de proyecto con permisos, una caducidad opcional y un estado que puede desactivar.
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
}Autenticación y permisos
- Una clave de portador
Envíe la clave de su proyecto en la cabecera Authorization de cada llamada, solo a través de HTTPS.
- Limitada a un proyecto
Una clave está vinculada a un proyecto y nunca puede leer ni escribir los datos de otro proyecto, sea cual sea la solicitud.
- Guardada como hash
Solo se conserva un hash de la clave, por lo que una clave se muestra completa una sola vez. Una clave perdida se sustituye, nunca se recupera.
Lance una ejecución y lea su respuesta
- Crear
Indique la aplicación y facilite un valor por cada campo de entrada, identificado con el nombre de campo que devuelve la aplicación.
- Seguir
Las ejecuciones son asíncronas: consulte la ejecución hasta que su estado sea terminada o fallida. Ambos estados son definitivos.
- Leer
Una ejecución terminada incluye su respuesta, su duración y sus recuentos de tokens de entrada y de salida.
Un mismo formato para cada respuesta
- Siempre los mismos tres campos
Cada respuesta incluye el código de estado, un título breve y el resultado, tanto en caso de éxito como de error.
- Mensajes estables
Los mensajes de error son cadenas estables en inglés que indican el permiso que falta o el valor rechazado.
- Límites del plan explícitos
Una llamada que el plan no cubre, o que superaría su cuota, se rechaza con su propio código de estado.
Obtener una clave
El acceso a la API se incluye en los planes de pago de Ultineo Reasoning. Todavía no hay registro autónomo: nuestro equipo abre su proyecto y le entrega su primera clave.
Conecte su software a Ultineo Reasoning
Díganos qué quiere automatizar y abriremos su proyecto y su clave de API.
Preguntas sobre la API
Los planes de pago. El plan gratuito da acceso a las aplicaciones sin la API.
No. Las instrucciones pertenecen al propietario de la aplicación. La API devuelve los campos de entrada, que son lo que rellena quien hace la llamada.
Crear una ejecución responde de inmediato con el nuevo estado. Consulte la ejecución hasta que termine para obtener la respuesta.
Sí. Cada clave tiene permisos y una caducidad opcional, y una clave nunca puede crear otra clave con permisos más amplios que los suyos.