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

# Authentication and API scopes

Use a Bearer API key with the smallest set of scopes required by your Rankability integration.

## Authentication header

```
Authorization: Bearer YOUR_API_KEY
```

Send keys only to `https://rankability.com/api/agent/v1`. Do not place a secret in browser code, a public repository, or a shared document.

## Current scopes

| Area                | Scopes                                            |
| ------------------- | ------------------------------------------------- |
| Copywriter          | `copywriter:run`, `copywriter:read`               |
| Reporter            | `reporter:read`, `reporter:run`, `reporter:write` |
| Researcher          | `researcher:run`, `researcher:read`               |
| Clients             | `clients:read`, `clients:write`                   |
| Help knowledge base | `kb:read`                                         |
| Optimize            | `optimize:run`                                    |
| Page Auditor        | `page_audit:read`, `page_audit:write`             |
| Site Auditor        | `site-auditor:read`, `site-auditor:write`         |
| Search Intelligence | `search_intelligence:query`                       |
| Crawler             | `scrape:run`, `crawl:run`, `extract:run`          |

## Key lifecycle

A key can have a name, scopes, and optional expiration. You can edit its name and scopes or revoke it. A revoked secret cannot be restored.

## Least privilege

Separate integrations by purpose. For example, a reporting connector normally needs read scopes, not client deletion or content-run permissions.


---

# 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://help.rankability.com/api/api-authentication.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.