A API do Ultineo Reasoning
Execute os aplicativos do catálogo a partir do seu próprio software. A API fala JSON sobre HTTPS, autentica cada chamada com uma chave de projeto e responde a todas as chamadas no mesmo formato.
Construída em torno de aplicativos, execuções e chaves
- Aplicativos
Crie um aplicativo a partir de um modelo, de seus campos de entrada e de suas instruções e, depois, liste, consulte e edite seus aplicativos.
- Execuções e cota
Uma chamada inicia um aplicativo com suas entradas; outra consulta a execução com a resposta. Um resumo mostra os tokens restantes no seu ciclo de faturamento.
- Chaves
Chaves de projeto com escopos, validade opcional e um status que você pode desativar.
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
}Autenticação e escopos
- Uma chave do tipo bearer
Envie a chave do seu projeto no cabeçalho Authorization de cada chamada, somente por HTTPS.
- Restrita a um projeto
Uma chave está vinculada a um projeto e nunca pode ler nem gravar os dados de outro projeto, seja qual for a solicitação.
- Armazenada como hash
Só um hash da chave é guardado, por isso a chave é exibida por completo uma única vez. Uma chave perdida é substituída, nunca recuperada.
Inicie uma execução e leia a resposta
- Criar
Informe o aplicativo e forneça um valor para cada campo de entrada, identificado pelo nome do campo que o aplicativo retorna.
- Acompanhar
As execuções são assíncronas: consulte a execução até que o status seja concluída ou com falha. Os dois são definitivos.
- Ler
Uma execução concluída traz a resposta, a duração e as contagens de tokens de entrada e de saída.
Um mesmo formato para todas as respostas
- Sempre os mesmos três campos
Toda resposta traz o código de status, um título curto e o retorno, tanto em caso de sucesso quanto de falha.
- Mensagens estáveis
As mensagens de erro são textos estáveis em inglês que indicam o escopo ausente ou o valor recusado.
- Limites do plano explícitos
Uma chamada que o plano não cobre, ou que ultrapassaria a franquia dele, é recusada com um código de status próprio.
Como obter uma chave
O acesso à API está incluído nos planos pagos do Ultineo Reasoning. Ainda não há cadastro por conta própria: nossa equipe abre o seu projeto e entrega a você a primeira chave.
Conecte o seu software ao Ultineo Reasoning
Conte-nos o que você quer automatizar e abriremos o seu projeto e a chave de API dele.
Perguntas sobre a API
Os planos pagos. O plano gratuito dá acesso aos aplicativos, sem a API.
Não. As instruções pertencem ao dono do aplicativo. A API retorna os campos de entrada, que são o que quem faz a chamada preenche.
A criação de uma execução retorna na hora com o novo status. Consulte a execução até que ela termine para obter a resposta.
Sim. Cada chave tem escopos e uma validade opcional, e uma chave nunca pode criar outra chave com escopo mais amplo que o seu.