A API do Ultineo AI
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 três recursos
- Catálogo
Os aplicativos publicados, dos mais usados para os menos usados, cada um com os campos de entrada que espera.
- Execuções
Uma chamada inicia um aplicativo com suas entradas; outra consulta a execução com a resposta.
- Chaves
Chaves de projeto com escopos, validade opcional e um status que você pode desativar.
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 catálogo 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 AI. 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 AI
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.