> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/piloterr.md).

# Piloterr

https\://app.piloterr.com

The Piloterr connector (*Get Website HTML*, *Get Usage*, *Make API Call*) authenticates with a Piloterr API key. Each user enters their own key when they connect an account in the Designer, so you do not need to register an app with Piloterr.

Piloterr is a web scraping API. *Get Website HTML* fetches the HTML of a public page, *Get Usage* reads the credits of the connected account, and *Make API Call* reaches any of the other Piloterr endpoints (search engines, company data, e-commerce and more) at `https://api.piloterr.com`.

## Get an API key

1. Sign up or sign in at [app.piloterr.com](https://app.piloterr.com). A new account starts with a small free trial credit pack, no credit card needed.
2. Copy your API key from the dashboard.
3. In the Appmixer Designer, connect a Piloterr account and paste the key into the *API Key* field.

Appmixer checks the key with `GET https://api.piloterr.com/v2/usage`, which uses no credits. Piloterr has no profile endpoint, so the connection is labelled with the masked key (for example `a1b2c3d4...wxyz`).

{% hint style="warning" %}
Treat the API key like a password. Anyone who has it can run requests that use the credits of your Piloterr account.
{% endhint %}

## Credits and limits

Every request except *Get Usage* uses Piloterr credits. The engine of *Get Website HTML* decides the price:

* *Crawler* fetches the page over plain HTTP. It is the cheapest engine: 1 credit per page.
* *Rendering* loads the page in a headless browser, for pages that build their content with JavaScript. It costs 2 credits per page.
* *Web Unlocker* gets past anti-bot protection. It is the most expensive engine, about three times the crawler price.

See [Piloterr pricing](https://www.piloterr.com/pricing) for the current prices. Use *Get Usage* in a flow to watch the remaining credits and the renewal date.

Piloterr plans allow 7 to 15 requests per second. The connector queues requests at 300 per minute per user, so flows stay inside every plan.

## Large pages

A rendered page can be several megabytes. Turn on *Save HTML as File* in *Get Website HTML* to store the HTML as an Appmixer file. The component then outputs the file ID, file name and size instead of the HTML text, and the next components can load or upload the file.

## Make API Call

*Make API Call* takes a path relative to `https://api.piloterr.com`, for example `/v2/usage`. A full URL is accepted only when it points at `https://api.piloterr.com`. Any other host is refused, so the API key is never sent elsewhere. The key is added to every request in the `x-api-key` header, and an `x-api-key` or `Authorization` header entered by the user is dropped.

## Troubleshooting

* **"Invalid Piloterr API key."** when connecting: the key is wrong or was deleted. Copy it again from the dashboard.
* **"Piloterr: ..."** errors: the message comes from the Piloterr API, for example an invalid URL or no credits left. Check the remaining credits with *Get Usage*.
* **"Piloterr returned an unexpected response"**: the API answered with something other than the page HTML. Try another engine, for example *Rendering* or *Web Unlocker* for protected sites.

## Backoffice configuration

No Backoffice configuration is required. The connector does not read any configuration keys.

Configuration ID: `appmixer:piloterr` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/piloterr.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
