> For the complete documentation index, see [llms.txt](https://developers.ranklytics.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.ranklytics.ai/getting-started/publish-your-docs.md).

# Authentication

Ranklytics API uses API Key & Secret Key for authentication. You can create API keys at the account level from "API" link within your top right menu. 

**Remember that your API Key & Secret Key is a secret!** Do not share it with others or expose it with any client-side code (Browsers, Apps). Production request must be routed through your own backend server where your API & Secret Key can be securely loaded from an environment variable.

All API requests should include the API Key & Secret key in the HTTP Header as follows:

```
X-API-KEY: your_api_key_here
X-SECRET-KEY: your_secret_key_here
```

Example curl command

```bash
curl -X GET https://api.ranklytics.ai/ \
  -H "X-API-KEY: your_api_key_here" \
  -H "X-SECRET-KEY: your_secret_key_here" \
  -H "Content-Type: application/json"

```


---

# 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://developers.ranklytics.ai/getting-started/publish-your-docs.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.