> For the complete documentation index, see [llms.txt](https://ajuda.botconversa.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.botconversa.com.br/integracoes/api-botconversa/documentacao-api-botconversa.md).

# Documentação API BotConversa

{% embed url="<https://youtu.be/8c0RRJ81cPY>" %}

## ❓ Como acessar a documentação API do BotConversa?

{% embed url="<https://backend.botconversa.com.br/swagger>" %}
**Clique** acima para ser redirecionado para a DOCUMENTAÇÃO API DO BOTCONVERSA
{% endembed %}

### Copie a chave de integração API do BotConversa:

* Acesse sua companhia do botconversa, vá em configurações > integrações e copie a chave: **Webhook Integration**

<figure><img src="/files/vAA5vDaTulicxgbm8rbk" alt=""><figcaption><p>Copie a chave: WEBHOOK INTEGRATION</p></figcaption></figure>

### Acesse a nossa documentação e Faça Testes de Requisições:

Ao acessar nossa documentação, clique no botão localizado no canto direito da página: **AUTHORIZE** e insira a **chave API** que copiou em sua companhia conforme descrito acima.

&#x20;      ![](/files/fviLx1t1A9jXNotEAj1n)      **➡️**      ![](/files/cAG4OmQ7f1NWzRtm7Yg3)

Após cadastrado a CHAVE API, você está pronto para realizar seus testes de requisições direto pela nossa documentação. Basta clicar no endpoint que deseja testar e então clicar em "TRY IT OUT" como mostra na imagem abaixo:

<figure><img src="/files/0KkRwR0yBRYbH12v7dly" alt=""><figcaption></figcaption></figure>

## **❓ O que é possível fazer utilizando os Endpoints do BotConversa?**

Basicamente, os endpoints possuem funcionalidades específicas e muito usadas no BotConversa, com a diferença de poder ser realizada através de um software externo, como:

* Adicionar Contatos na Audiência&#x20;
* Deletar um contato de uma companhia
* Adicionar Etiquetas em Contatos
* Adicionar Campos Personalizados em Usuários
* Enviar uma Mensagem para um Usuário&#x20;
* Enviar um Fluxo para um usuário
* Cadastrar o Usuário em uma Sequência&#x20;
* Cadastrar o Usuário em uma Campanha
* Atribuir um Contato para um Atendente
* Definir Valores aos Campos do Robô&#x20;

{% hint style="warning" %}
Estude com atenção as APIs e não deixe de ver o vídeo no início desse artigo.\
\
Caso queira ver tutoriais prontos e explicados por nós, utilize a barra lateral para navegar pelos tutoriais de [Softwares.](/integracoes/ferramentas-online.md)
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.botconversa.com.br/integracoes/api-botconversa/documentacao-api-botconversa.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.