# API

The "API" section serves as a reference for available API methods in Swagger format. This section includes the following tabs:

* API Key
* Robot
* Robot Groups
* Process
* Process Version
* Job
* Queue
* Task
* Trigger
* Resource
* Storage
* Log
* Account

## API Key

In this section, the user can see their unique API access key, which must be passed in the HTTP header in the Key field. Additionally, when changing this field, the action must be confirmed by pressing one of the buttons:

![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdUwoo5AApulBnrl8HQFGNMRjuKkLmLaJcbYvcuJQXF1jeiynnVt91nZQlkzUEDmOPbVkeZjaCVISncQ91L98qvXW_KZZNfdiwK0SfAQdAIP6EHiKLMNPHFoy2cSNErcJt3zo_ccw?key=o0FHaGHt8wdv-FpDKfCXmTRa)(Assignment) - Assign a new key;

![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdM1_SevWweGyGRBOI0ejtche7yIIQxxIbutVqaHCyVm_sdUBkL39T4i7fdlnFbqlc8pohzKSJRBawUwqFfhOFxQkhm28k5BPL8Qhf1E1yVguY40db3BEQxZar_PUYfFFJlERka7g?key=o0FHaGHt8wdv-FpDKfCXmTRa) (Refresh) - Refresh the current key.

Below is the information field "Authorization," which is used to provide the access token confirming that the User has the right to perform the requested action.

Example:

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

“Bearer” — token type,

“Y2Y5M2U3OGUtMDk1ZC00MGNjLTkwNWUtZTYyNjUwMTg5YjU2” — the token itself, which the server will use to identify the User.

API requests must include the mandatory API Key, which is stored in the Account settings. Detailed examples of requests are provided in the section for each block separately.

Response codes:

<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/en/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.