Ultineo Reasoning

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 seus campos de entrada e de suas instruções e, depois, liste, consulte e edite seus aplicativos.

Runs and usage

Uma chamada inicia um aplicativo com suas entradas; outra consulta a execução com a resposta. Um resumo mostra os tokens usados na semana de faturamento atual e o valor correspondente.

Chaves

Chaves de projeto com escopos, validade opcional e um status que você pode desativar.

Integre em qualquer lugar

In your software

Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.

Nas suas automações

A script or an automation tool launches a run at each event: a form received, a file dropped.

De uma resposta à próxima

A resposta de uma execução pode se tornar um campo da próxima: seu código encadeia as etapas como bem entende.

Reasoning chains

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.

O que você envia

{
  "app_id": "mapp_0ceacb46e5b3a99e91b6",
  "data": {
    "message": "My parcel has not arrived and the tracking has not moved for a week."
  }
}

O que você lê de volta

{
  "id": "runi_1b7f4e0c96a2d8531fca",
  "object": "reasoning",
  "status": "finished",
  "response": { "miid_9a4c07e5b312df8641ca": "urgent" },
  "tokens": { "input": 412, "output": 3, "total": 415 },
  "duration": 1.84
}

Read the API documentation

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.

The runs your software started, one by one

Every call made through the API appears in the reasonings list, marked API, with its duration and its tokens. Each application shows the identifier your software calls.

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.

Refusals are explicit

A call that cannot be accepted, for example while an invoice is overdue, is refused with its own status code.

Como obter uma chave

API access is included with Ultineo Reasoning. There is no self-service sign-up: our team opens your project and hands you its first key.

See the pricing

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

Yes. Every project can call the API; a call is billed like any other run, on the tokens it uses.

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.