Dúvidas comuns sobre o uso da API na Tess AI

Reunimos algumas questões levantadas recentemente por nossos clientes e colaboradores, e preparamos um guia com explicações claras e soluções práticas.

Sabemos que, ao explorar uma plataforma inovadora como a nossa, dúvidas e desafios podem surgir. Por isso, reunimos algumas questões levantadas recentemente por nossos clientes e colaboradores, e preparamos um guia com explicações claras e soluções práticas. Nosso objetivo é garantir que você aproveite ao máximo todos os recursos da Tess AI.

Descomplicando Endpoints, URLs Base e Swagger

O universo da API pode parecer um labirinto, mas estamos aqui para simplificar!

Documentação da API

Você pode acessar a documentação da api da Pareto neste link aqui

O Que é uma API e Por Que Usá-la na Tess AI?

API, ou Interface de Programação de Aplicações, é um conjunto de regras que permite que diferentes softwares se comuniquem entre si. Na Tess AI, a API permite que você:

• Acesse recursos: Utilize nossos modelos de IA, crie agentes, gerencie seus agentes e muito mais.
• Automatize tarefas: Integre a Tess AI em seus fluxos de trabalho e automatize processos.
• Crie soluções personalizadas: Desenvolva aplicativos e integrações com a Tess AI que atendam às suas necessidades específicas.

Conceitos Fundamentais da API da Tess AI

Para começar a usar a nossa API, é importante entender alguns conceitos básicos:

• URL Base: É o endereço principal da API, a base para todas as suas requisições. A URL base da Tess AI é: tess.pareto.io (ou similar, verifique a documentação mais recente). Importante: Certifique-se de usar a URL base da Tess AI e não a da OpenAI ou de outros serviços de IA.
• Endpoints: São "endereços" específicos dentro da API que permitem realizar ações distintas. Cada endpoint é responsável por uma operação específica, como:
  • GET /templates: Para obter uma lista de templates.
  • POST /agents: Para executar um agente.
  • POST /chat/completions: Para iniciar uma conversa de chat com um modelo.
  • GET /users/me: Para obter dados do usuário autenticado.
    
    E muito mais! Consulte a documentação da API para a lista completa.
• Métodos HTTP: São ações que você pode realizar em um endpoint. Os mais comuns são:
  • GET: Para obter informações.
  • POST: Para enviar dados e criar ou atualizar recursos.
  • PUT: Para atualizar recursos existentes.
  • DELETE: Para remover recursos.
• Autenticação: Para usar a API, você precisará de um token de autenticação (API Key). Ele é usado para identificar e autorizar suas solicitações. Você pode obter seu token na plataforma da Tess AI, nas configurações do seu usuário.
• Formato de Dados: Geralmente, os dados são enviados e recebidos no formato JSON (JavaScript Object Notation), um formato leve e fácil de processar.

Usando a API para Interagir com Modelos de IA

Uma das principais funcionalidades da API é a interação com os modelos de IA. Aqui está um exemplo de como você pode usar o endpoint /chat/completions para iniciar uma conversa:

// Exemplo de Requisição POST para /chat/completions

{
    "model": "gpt-3.5-turbo", // O modelo de IA a ser utilizado
    "messages": [
      {
        "role": "user", // O papel da mensagem (user ou assistant)
        "content": "Olá, tudo bem?" // A mensagem do usuário
      }
    ],
    "root_id": "rootId_exemplo" // Opcional: Para continuar uma conversa existente
}

// Exemplo de Resposta

{
  "id": "chatcmpl-8QnZJqgU8o0i9r9tXnK9aV6y2U3eJ",
  "object": "chat.completion",
  "created": 1705580315,
  "model": "gpt-3.5-turbo-0613",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Olá! Tudo bem por aqui. Como posso ajudar você hoje?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 15,
    "total_tokens": 27
  },
   "root_id": "rootId_exemplo_retornado" // O novo root_id da conversa, se não foi passado um
}

Dicas Importantes:

• Root IDs para Conversas: Use o root_id para manter o histórico das suas conversas. Se você não incluir um root_id em uma nova solicitação, uma nova conversa será iniciada. A resposta do endpoint sempre retorna um root_id.
• Modelos: Consulte a documentação para ver quais modelos estão disponíveis e quais são as suas funcionalidades.
• Consumo de Tokens: Lembre-se que cada requisição usa tokens. Monitore seu consumo e otimize suas chamadas.

Gerenciando Templates e Agentes Via API

A API também oferece funcionalidades para:

• Criar e gerenciar templates: Use o endpoint /templates para criar, obter, atualizar ou excluir seus templates.
• Executar e gerenciar agentes: Use o endpoint /agents para executar seus agentes e integrá-los em seus fluxos de trabalho.

Erros Comuns na API e Como Solucioná-los

• Erro de Autenticação (401): Verifique se seu token de API está correto e se você o está incluindo no cabeçalho da sua requisição (geralmente no cabeçalho Authorization: Bearer <seu_token>).
• Erro de Endpoint Não Encontrado (404): Verifique se o endpoint que você está utilizando está correto e se você está utilizando o método HTTP adequado.
• Erro de Formato de Dados (400): Verifique se você está enviando os dados no formato correto (geralmente JSON) e se todos os campos obrigatórios estão preenchidos.
• Erro de Limite de Solicitações (429): Se você estiver recebendo esse erro, você está fazendo muitas solicitações em um curto período de tempo. Tente reduzir a frequência de suas requisições ou implementar um mecanismo de retry.

A API da Tess AI pode sofrer alterações. Consulte sempre a documentação mais recente.

Conclusão

A API da Tess AI é uma ferramenta poderosa que permite que você construa soluções inovadoras e expanda as capacidades da nossa plataforma. Use a documentação do Swagger, explore os endpoints, siga as dicas que listamos aqui e comece a transformar suas ideias em realidade!

Se você tiver alguma dúvida ou precisar de ajuda, não hesite em entrar em contato com nossa equipe de suporte.

Até a próxima!

Equipe Tess AI