# Listar contas
Source: https://docs.rdstationmentoria.com.br/api-reference/accounts/listar-contas

https://api.contas.rdstationmentoria.com.br/rest get /accounts
Retorna as contas (integrações) configuradas.



# Obter conta
Source: https://docs.rdstationmentoria.com.br/api-reference/accounts/obter-conta

https://api.contas.rdstationmentoria.com.br/rest get /accounts/platform:{platform}
Retorna a conta configurada para uma plataforma.



# Atualizar assistente
Source: https://docs.rdstationmentoria.com.br/api-reference/agents/atualizar-assistente

https://api.meuassistente.rdstationmentoria.com.br/rest put /agents/{id}
Atualiza os dados de um assistente.



# Criar assistente
Source: https://docs.rdstationmentoria.com.br/api-reference/agents/criar-assistente

https://api.meuassistente.rdstationmentoria.com.br/rest post /agents
Cria um novo assistente com as configurações fornecidas.



# Listar assistentes
Source: https://docs.rdstationmentoria.com.br/api-reference/agents/listar-assistentes

https://api.meuassistente.rdstationmentoria.com.br/rest get /agents
Lista assistentes com base nos parâmetros fornecidos.



# Obter assistente
Source: https://docs.rdstationmentoria.com.br/api-reference/agents/obter-assistente

https://api.meuassistente.rdstationmentoria.com.br/rest get /agents/{id}
Recupera os detalhes de um assistente.



# Remover assistente
Source: https://docs.rdstationmentoria.com.br/api-reference/agents/remover-assistente

https://api.meuassistente.rdstationmentoria.com.br/rest delete /agents/{id}
Remove um assistente.



# Listar canais
Source: https://docs.rdstationmentoria.com.br/api-reference/channels/listar-canais

https://api.meuassistente.rdstationmentoria.com.br/rest get /agents/{agentId}/channels
Lista todos os canais associados a um assistente.



# Enviar mensagem
Source: https://docs.rdstationmentoria.com.br/api-reference/chat/enviar-mensagem

https://chat.meuassistente.rdstationmentoria.com.br/docs post /api/{agentId}
Envia mensagens para uma conversa (thread). As mensagens podem conter texto, imagem ou áudio. O modelo processará o conteúdo enviado e gerará a próxima mensagem da conversa com base no contexto.



# Listar conversas
Source: https://docs.rdstationmentoria.com.br/api-reference/conversations/listar-conversas

https://api.meuassistente.rdstationmentoria.com.br/rest get /conversations/list/{agentId}
Lista as conversas associadas a um assistente.



# Obter conversa
Source: https://docs.rdstationmentoria.com.br/api-reference/conversations/obter-conversa

https://api.meuassistente.rdstationmentoria.com.br/rest get /conversations/{id}
Recupera as mensagens de uma conversa.



# Remover conversa
Source: https://docs.rdstationmentoria.com.br/api-reference/conversations/remover-conversa

https://api.meuassistente.rdstationmentoria.com.br/rest delete /conversations/{id}
Remove uma conversa.



# Ativar campo
Source: https://docs.rdstationmentoria.com.br/api-reference/fields/ativar-campo

https://api.meuassistente.rdstationmentoria.com.br/rest put /fields/{id}/enable
Ativa um campo, permitindo que seja utilizado em assistentes.



# Atualizar campo
Source: https://docs.rdstationmentoria.com.br/api-reference/fields/atualizar-campo

https://api.meuassistente.rdstationmentoria.com.br/rest put /fields/{id}
Atualiza as informações de um campo.



# Criar campo
Source: https://docs.rdstationmentoria.com.br/api-reference/fields/criar-campo

https://api.meuassistente.rdstationmentoria.com.br/rest post /fields
Cria um novo campo.



# Inativar campo
Source: https://docs.rdstationmentoria.com.br/api-reference/fields/inativar-campo

https://api.meuassistente.rdstationmentoria.com.br/rest put /fields/{id}/disable
Inativa um campo, impedindo seu uso por assistentes.



# Listar campos
Source: https://docs.rdstationmentoria.com.br/api-reference/fields/listar-campos

https://api.meuassistente.rdstationmentoria.com.br/rest get /fields
Lista os campos com base nos parâmetros fornecidos.



# Obter campo
Source: https://docs.rdstationmentoria.com.br/api-reference/fields/obter-campo

https://api.meuassistente.rdstationmentoria.com.br/rest get /fields/{id}
Recupera detalhes de um campo.



# Get connectionsauthcallback
Source: https://docs.rdstationmentoria.com.br/api-reference/get-connectionsauthcallback

https://api.meuassistente.rdstationmentoria.com.br/rest get /connections/auth/callback



# Utilização no mês
Source: https://docs.rdstationmentoria.com.br/api-reference/interactions/utilização-no-mês

https://api.meuassistente.rdstationmentoria.com.br/rest get /interactions
Recupera dados de utilização do mês corrente.



# Atualizar base de conhecimento
Source: https://docs.rdstationmentoria.com.br/api-reference/knowledge/atualizar-base-de-conhecimento

https://api.bases.rdstationmentoria.com.br/rest put /bases/{id}
Atualiza o nome e outras configurações de uma base de conhecimento existente.



# Criar base de conhecimento
Source: https://docs.rdstationmentoria.com.br/api-reference/knowledge/criar-base-de-conhecimento

https://api.bases.rdstationmentoria.com.br/rest post /bases
Cria uma nova base de conhecimento.



# Listar bases de conhecimento
Source: https://docs.rdstationmentoria.com.br/api-reference/knowledge/listar-bases-de-conhecimento

https://api.bases.rdstationmentoria.com.br/rest get /bases
Retorna uma lista das bases de conhecimento.



# Obter base de conhecimento
Source: https://docs.rdstationmentoria.com.br/api-reference/knowledge/obter-base-de-conhecimento

https://api.bases.rdstationmentoria.com.br/rest get /bases/{id}
Retorna os dados completos de uma base de conhecimento.



# Remover base de conhecimento
Source: https://docs.rdstationmentoria.com.br/api-reference/knowledge/remover-base-de-conhecimento

https://api.bases.rdstationmentoria.com.br/rest delete /bases/{id}
Remove uma base de conhecimento do workspace atual.



# Criar lead
Source: https://docs.rdstationmentoria.com.br/api-reference/leads/criar-lead

https://api.meuassistente.rdstationmentoria.com.br/rest post /leads
Cria um novo lead.



# Listar leads
Source: https://docs.rdstationmentoria.com.br/api-reference/leads/listar-leads

https://api.meuassistente.rdstationmentoria.com.br/rest get /leads
Lista leads com base nos parâmetros fornecidos.



# Obter lead
Source: https://docs.rdstationmentoria.com.br/api-reference/leads/obter-lead

https://api.meuassistente.rdstationmentoria.com.br/rest get /leads/{id}
Recupera informações detalhadas de um lead.



# Remover lead
Source: https://docs.rdstationmentoria.com.br/api-reference/leads/remover-lead

https://api.meuassistente.rdstationmentoria.com.br/rest delete /leads/{id}
Remove um lead específico pelo ID.



# Cancelar convite
Source: https://docs.rdstationmentoria.com.br/api-reference/memberships/cancelar-convite

https://api.contas.rdstationmentoria.com.br/rest delete /memberships/invite
Cancela um convite.



# Enviar convite
Source: https://docs.rdstationmentoria.com.br/api-reference/memberships/enviar-convite

https://api.contas.rdstationmentoria.com.br/rest post /memberships/invite
Envia um convite a um usuário por e-mail.



# Listar membros
Source: https://docs.rdstationmentoria.com.br/api-reference/memberships/listar-membros

https://api.contas.rdstationmentoria.com.br/rest get /memberships
Retorna os membros (usuários) do workspace.



# Remover membro
Source: https://docs.rdstationmentoria.com.br/api-reference/memberships/remover-membro

https://api.contas.rdstationmentoria.com.br/rest delete /memberships/{id}
Remove um membro do workspace.



# Atualizar permissões
Source: https://docs.rdstationmentoria.com.br/api-reference/roles/atualizar-permissões

https://api.contas.rdstationmentoria.com.br/rest put /roles/{membershipId}
Atualiza as permissões de um membro (usuário).



# Listar permissões
Source: https://docs.rdstationmentoria.com.br/api-reference/roles/listar-permissões

https://api.contas.rdstationmentoria.com.br/rest get /roles/{membershipId}
Retorna as permissões de um membro (usuário).



# Obter permissões
Source: https://docs.rdstationmentoria.com.br/api-reference/roles/obter-permissões

https://api.contas.rdstationmentoria.com.br/rest get /roles/{membershipId}/{appId}
Retorna as permissões de um membro (usuário) para um aplicativo da plataforma.



# Atualizar configurações
Source: https://docs.rdstationmentoria.com.br/api-reference/settings/atualizar-configurações

https://api.meuassistente.rdstationmentoria.com.br/rest post /settings
Atualiza as configurações da aplicação.



# Obter configurações
Source: https://docs.rdstationmentoria.com.br/api-reference/settings/obter-configurações

https://api.meuassistente.rdstationmentoria.com.br/rest get /settings
Recupera as configurações atuais da aplicação.



# Listar assinaturas
Source: https://docs.rdstationmentoria.com.br/api-reference/subscriptions/listar-assinaturas

https://api.contas.rdstationmentoria.com.br/rest get /subscriptions
Lista todas as assinaturas do workspace atual.



# Obter assinatura
Source: https://docs.rdstationmentoria.com.br/api-reference/subscriptions/obter-assinatura

https://api.contas.rdstationmentoria.com.br/rest get /subscriptions/current
Retorna detalhes sobre a assinatura em vigor.



# Atualizar workspace
Source: https://docs.rdstationmentoria.com.br/api-reference/workspaces/atualizar-workspace

https://api.contas.rdstationmentoria.com.br/rest put /workspaces/current
Atualiza informações do workspace.



# Obter workspace
Source: https://docs.rdstationmentoria.com.br/api-reference/workspaces/obter-workspace

https://api.contas.rdstationmentoria.com.br/rest get /workspaces/current
Retorna detalhes do workspace.



# Erros
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/api/errors

Informações sobre códigos de erro HTTP e tratamento de erros na API do MentorIA

A API do MentorIA segue um formato previsível de códigos de erro HTTP:

* 400 - `invalid_request_error`: Houve um problema com o formato da sua solicitação.
  Também podemos usar este tipo de erro para outros códigos de status 4XX não listados abaixo.
* 401 - `authentication_error`: Há um problema com sua chave de API.
* 403 - `permission_error`: Sua chave de API não tem permissão para usar o recurso especificado.
* 404 - `not_found_error`: O recurso solicitado não foi encontrado.
* 413 - `request_too_large_error`: A solicitação excede o número máximo permitido de bytes.
* 422 - `unprocessable_entity_error`: O conteúdo da sua solicitação é inválido.
* 429 - `rate_limit_error`: Sua conta atingiu um limite de taxa.
* 500 - `api_error`: Ocorreu um erro inesperado interno aos sistemas do MentorIA.
* 529 - `overloaded_error`: A API do MentorIA está temporariamente sobrecarregada.


# Limites
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/api/limits

Limites ao utilizar a API do MentorIA

Para mitigar o uso indevido e gerenciar a capacidade em nossa API, implementamos limites
sobre quanto uma organização pode usar a API do MentorIA.

Temos dois tipos de limites:

* **Limites de gastos**: estabelecem um custo mensal máximo que uma organização pode
  incorrer pelo uso da API.
* **Limites de taxa**: estabelecem o número máximo de solicitações de API que uma
  organização pode fazer durante um período de tempo definido.

Aplicamos limites configurados pelo serviço no nível da organização.

## Sobre nossos limites

* Os limites são projetados para prevenir o abuso da API, minimizando o impacto nos
  padrões comuns de uso do cliente.
* Os limites são definidos por tier de uso, onde cada tier está associado a um conjunto
  diferente de limites de gastos e taxas.
* Todos os limites descritos aqui representam o uso máximo permitido, não mínimos
  garantidos. Esses limites destinam-se a reduzir gastos excessivos não intencionais
  e garantir uma distribuição justa de recursos entre os usuários.

## Limites de taxa

Nossos limites de taxa para a API geralmente são medidos em solicitações por minuto
(RPM). Se você exceder um dos limites de taxa, receberá um erro 429 descrevendo qual
limite de taxa foi excedido, junto com um cabeçalho `retry-after` indicando quanto
tempo esperar.


# Visão geral
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/api/overview



## Autenticação

Todas as solicitações para a API do MentorIA devem incluir um cabeçalho `Authorization`
do tipo `Bearer` com sua chave de API. Se você estiver usando uma SDK como cliente, você
deve definir a chave de API ao construir um cliente, e então o SDK enviará o cabeçalho
em seu nome com cada solicitação. Se estiver integrando diretamente com a API, você
precisará enviar este cabeçalho por conta própria.

Para obter sua chave de API, acesse [**Contas -> Configurações -> Chaves de API**](https://contas.rdstationmentoria.com.br/settings/keys)
e gere uma nova chave. Armazene-a em um local seguro, pois ela não será mais apresentada
no console.

## Playground

Você pode usar o [Playground](/api-reference) para testar a API no navegador e visualizar
detalhes dos recursos disponíveis.

## Tipos de conteúdo

A API do MentorIA sempre aceita JSON no corpo das solicitações e retorna JSON no corpo
das respostas. Você precisará enviar o cabeçalho `Content-Type: application/json` nas
solicitações. Se você estiver usando SDKs, isso será tratado automaticamente.

## Exemplos

<Tabs>
  <Tab title="cURL">
    ```sh theme={null}
    curl https://api.conteudo.restationmentoria.com.br/rest/completions \
     --header "authorization: $MENTORIA_API_KEY" \
     --header "content-type: application/json" \
     --data \
      '{
          "messages": [
              {"role": "user", "content": "Hello, world"}
          ]
      }'
    ```
  </Tab>
</Tabs>


# Comece a usar
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/get-started

Vamos aprender como usar a API do MentorIA 

## Introdução

Neste exemplo, vamos pedir ao MentorIA para elaborar um poema curto.

<Tip>
  Para mais exemplos de código, confira a referência do endpoint [Criar
  conclusão](/api-reference/completions/post-completions).
</Tip>

***

## Pré-requisitos

Antes de começar, você vai precisar:

<AccordionGroup>
  <Accordion icon="square-user" title="Criar uma conta no MentorIA">
    Crie uma conta gratuita no MentorIA utilizando [este
    link](http://contas.rdstationmentoria.com.br/).
  </Accordion>

  <Accordion icon="key" title="Gerar uma chave de API">
    Acesse [**Contas -> Configurações -> Chaves de
    API**](https://contas.rdstationmentoria.com.br/settings/keys) e gere uma
    nova chave de API. Armazene-a em um local seguro, pois ela não será mais
    apresentada no console.
  </Accordion>

  <Accordion icon="square-terminal" title="Selecionar um cliente HTTP">
    Você pode usar [**Postman**](https://postman.com/),
    [**Insomnia**](https://insomnia.rest/), **cURL** ou o seu cliente favorito.
    Certifique-se de que ele esteja instalado e configurado corretamente antes
    de continuar.
  </Accordion>
</AccordionGroup>

***

## Chame a API

O endpoint [**`POST /completions`**](/api-reference/completions/post-completions) gera
uma conclusão a partir de um prompt. Veja abaixo um exemplo de solicitação:

```bash theme={null}
curl --request POST \
  --url https://api.conteudo.rdstationmentoria.com.br/rest/completions \
  --header "Authorization: Bearer <api_key>" \
  --header "Content-Type: application/json" \
  --data '{
    "system": "Você é um poeta reconhecido mundialmente. Responda apenas com poemas curtos.",
    "messages": [
      {
        "role": "user",
        "content": "Por que o mar é salgado?"
      }
    ]
  }'
```

Uma resposta típica pode ser:

```json theme={null}
{
  "completionId": "cpt-abc123",
  "output": {
    "role": "assistant",
    "content": "O choro antigo da Terra
Escorreu em rios ao chão –
No grande ventre do mar
Dissolveu toda paixão.
É sal o resto da mágoa,
É gosto do coração."
  }
}
```

<Tip>
  Caso ocorra algum erro, verifique se a chave de API foi informada corretamente
  e se você possui uma conexão estável com a internet.
</Tip>

## Próximos passos

Agora que você executou sua primeira solicitação à API do MentorIA, é hora de
explorar o que mais é possível fazer:

<Columns>
  <Card icon="trending-up-down" title="Casos de Uso" href="/how-to/use-cases">
    Guias de implementação completos para casos de uso comuns.
  </Card>

  <Card icon="workflow" title="Documentação de API" href="/api-reference">
    Consulte a referência completa de API e conheça os recursos disponíveis.
  </Card>
</Columns>


# Glossário
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/glossary

Conceitos e termos-chave para saber ao ler esta documentação

## Contexto

Contexto refere-se à quantidade de texto que um modelo de linguagem pode consultar e
referenciar ao gerar novo texto. Isso é diferente do grande corpus de dados em que o
modelo de linguagem foi treinado, e representa uma “memória de trabalho” para o modelo.

Uma janela de contexto maior permite que o modelo entenda e responda a prompts mais
complexos e extensos, enquanto uma janela de contexto menor pode limitar a capacidade do
modelo de lidar com prompts mais longos ou manter a coerência em conversas prolongadas.

## Latência

Latência, no contexto de IA generativa e grandes modelos de linguagem, refere-se ao tempo
que o modelo leva para responder a um determinado prompt. É o atraso entre o envio de um
prompt e o recebimento da saída gerada. Menor latência indica tempos de resposta mais
rápidos, o que é crucial para aplicações em tempo real, chatbots e experiências interativas.
Fatores que podem afetar a latência incluem o tamanho do modelo, capacidades de hardware,
condições de rede e a complexidade do prompt e o tamanho da resposta gerada.

## LLM

Grandes modelos de linguagem (LLMs - Large Language Models) são modelos de linguagem de IA
com muitos parâmetros que são capazes de realizar uma variedade de tarefas surpreendentemente
úteis. Esses modelos são treinados em vastas quantidades de dados de texto e podem gerar
texto semelhante ao humano, responder perguntas, resumir informações e muito mais.
O MentorIA oferece recursos que utilizam grandes modelos de linguagem internamente e foi
refinado e treinado para ser mais útil, honesto e inofensivo.

## Pré-treinamento

Pré-treinamento é o processo inicial de treinamento de modelos de linguagem em um grande
corpus não rotulado de texto. No caso do MentorIA, modelos de linguagem autorregressivos
são pré-treinados para prever a próxima palavra, dado o contexto anterior de texto no
documento. Esses modelos pré-treinados não são inerentemente bons em responder perguntas
ou seguir instruções, e frequentemente requerem habilidade profunda em engenharia de prompts
para obter os comportamentos desejados. Fine-tuning e RLHF são usados para refinar esses
modelos pré-treinados, tornando-os mais úteis para uma ampla gama de tarefas.

## RAG (Geração aumentada por recuperação)

Geração aumentada por recuperação (RAG - Retrieval Augmented Generation) é uma técnica que
combina recuperação de informações com geração de modelo de linguagem para melhorar a
precisão e relevância do texto gerado, e para melhor fundamentar a resposta do modelo em
evidências.

No RAG, um modelo de linguagem é aumentado com uma base de conhecimento externa
ou um conjunto de documentos que é passado para a janela de contexto. Os dados são
recuperados em tempo de execução quando uma consulta é enviada ao modelo, embora o próprio
modelo não necessariamente recupere os dados podemos fazê-lo com uso de ferramentas e uma
função de recuperação. Ao gerar texto, informações relevantes primeiro devem ser recuperadas
da base de conhecimento com base no prompt de entrada, e então passadas para o modelo junto
com a consulta original. O modelo usa essas informações para orientar a saída que gera.
Isso permite que o modelo acesse e utilize informações além de seus dados de treinamento,
reduzindo a dependência da memorização e melhorando a precisão factual do texto gerado.

RAG pode ser particularmente útil para tarefas que requerem informações atualizadas,
conhecimento específico de domínio ou citação explícita de fontes. No entanto, a eficácia
do RAG depende da qualidade e relevância da base de conhecimento e dos dados que são
recuperados em tempo de execução.

## Temperatura

Temperatura é um parâmetro que controla a aleatoriedade das previsões de um modelo
durante a geração de texto. Temperaturas mais altas levam a saídas mais criativas e
diversas,permitindo múltiplas variações na formulação e, no caso da ficção, variação
nas respostas também. Temperaturas mais baixas resultam em saídas mais conservadoras
e determinísticas que se atêm às formulações e respostas mais prováveis. Ajustar a
temperatura permite que os usuários incentivem um modelo de linguagem a explorar
escolhas e sequências de palavras raras, incomuns ou surpreendentes, em vez de
selecionar apenas as previsões mais prováveis.

## Tokens

Tokens são as menores unidades individuais de um modelo de linguagem, e podem
corresponder a palavras, subpalavras, caracteres ou até mesmo bytes. Um token
geralmente representa 3.5 caracteres de uma palavra, embora o número exato possa
variar dependendo do idioma usado. Os tokens são tipicamente ocultos ao interagir
com modelos de linguagem no nível de “texto”, mas se tornam relevantes ao examinar
as entradas e saídas exatas de um modelo de linguagem.

Quando um LLM recebe texto para avaliar, o texto (consistindo em uma série de caracteres)
é codificado em uma série de tokens para o modelo processar. Tokens maiores permitem
eficiência de dados durante a inferência e pré-treinamento (e são utilizados quando
possível), enquanto tokens menores permitem que um modelo lide com palavras incomuns
ou nunca antes vistas. A escolha do método de tokenização pode impactar o desempenho
do modelo, o tamanho do vocabulário e a capacidade de lidar com palavras fora do
vocabulário.


# Casos de uso
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/how-to/use-cases

Guias de implementação

O MentorIA foi projetado para se destacar em uma variedade de tarefas. Explore estes guias
detalhados para aprender como atender casos de uso comuns com as ferramentas RD Station.


# Introdução
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/introduction

Documentação oficial da API MentorIA

O MentorIA é a plataforma de inteligência artificial da [RD Station](https://rdstation.com). O MentorIA pode ser utilizado para tarefas como produção de conteúdos, qualificação leads, automação de atendimentos e muito mais.

***

## Principais capacidades

O MentorIA pode ajudar com diversas tarefas.

<Card title="Conteúdo" icon="text" href="/products/content">
  Utilize IA para produzir conteúdos para o seu site, blog, redes sociais,
  e-mails, anúncios e muito mais.
</Card>

<Card title="Meu Assistente" icon="bot" href="/products/agents">
  Crie assistentes virtuais para interagir com visitantes do seu site ou
  WhatsApp, qualifique leads e realize atendimentos automáticos.
</Card>

<Card title="Bases de Conhecimento" icon="book-text" href="/products/knowledge">
  Crie bases de conhecimento para pipelines RAG, garantindo resultados mais
  precisos e relevantes.
</Card>


# Privacidade
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/legal/privacy





# Termos de uso
Source: https://docs.rdstationmentoria.com.br/content/pt-BR/legal/terms