# API

A seção "API" é um guia sobre os métodos de API disponíveis no formato Swagger. Esta seção apresenta as seguintes abas:

* Chave (API Key)
* Robô
* Grupos de Robôs
* Processo
* Versão do Processo
* Trabalho
* Fila
* Tarefa
* Gatilho
* Recurso
* Armazenamento
* Log
* Conta

## Chave (API Key)

Nesta seção, o usuário pode ver sua chave de acesso única à API, que deve ser enviada no cabeçalho HTTP, no campo Chave. Além disso, ao alterar este campo, é necessário confirmar a ação pressionando um dos botões:

![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdUwoo5AApulBnrl8HQFGNMRjuKkLmLaJcbYvcuJQXF1jeiynnVt91nZQlkzUEDmOPbVkeZjaCVISncQ91L98qvXW_KZZNfdiwK0SfAQdAIP6EHiKLMNPHFoy2cSNErcJt3zo_ccw?key=o0FHaGHt8wdv-FpDKfCXmTRa)(Assignment) - Atribuir nova chave;

![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdM1_SevWweGyGRBOI0ejtche7yIIQxxIbutVqaHCyVm_sdUBkL39T4i7fdlnFbqlc8pohzKSJRBawUwqFfhOFxQkhm28k5BPL8Qhf1E1yVguY40db3BEQxZar_PUYfFFJlERka7g?key=o0FHaGHt8wdv-FpDKfCXmTRa) (Refresh) - Atualizar a chave atual.

Abaixo está o campo informativo "Authorization", que é usado para fornecer o token de acesso, confirmando que o Usuário tem permissão para realizar a ação solicitada.

Exemplo:

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfTw_GFtctIyw7virluPsOkadkwu9Iv5fVh7JEs5RPfL1N6QMhJMhhoNQe1xAcAJ8TcHUW3G6hXtrbH4oYeWyX1Jnx6avT8CdpDutcV8TCObnnIPTZoPiiAXs4NaBzSp-gMB7E4kg?key=o0FHaGHt8wdv-FpDKfCXmTRa" alt=""><figcaption></figcaption></figure>

“Bearer” — tipo de token,

“Y2Y5M2U3OGUtMDk1ZC00MGNjLTkwNWUtZTYyNjUwMTg5YjU2” — o próprio token, que o servidor usará para identificar o Usuário.

As solicitações à API devem incluir obrigatoriamente a Chave da API, que é armazenada nas configurações da Conta. Exemplos detalhados de solicitações são fornecidos na seção de cada bloco separadamente.

Códigos de resposta:

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXepIfjanO0OANtvmFvAcp9yk6l-kJYlkaXAjsNpUmzET9-ZIm2-UoUcKp8H61tDNcLtOPKP1YUrHigpb3i37ynQ3tftqo0HgnK8CYiVBXBlI4RRH-48ctzwC_iOpwUDFlBb5bCBtQ?key=o0FHaGHt8wdv-FpDKfCXmTRa" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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:

```
GET https://docs.sherparpa.ru/pt/sherpa-rpa/sherpa-orchestrator/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.