> 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-getting-started.md).

# Getting started with the API

Create a least-privilege API key and call the Rankability Agent API at <https://rankability.com/api/agent/v1>.

## Base URL and version

All current endpoints use:

```
https://rankability.com/api/agent/v1
```

Responses include `X-API-Version: 1.3.0`. There is no separate `/v2` namespace.

## Create a key

1. Open organization **Settings**.
2. Open **API keys**.
3. Create a key with only the scopes your integration needs.
4. Copy the secret when it is shown and store it securely.

## Authenticate

```
curl https://rankability.com/api/agent/v1/clients   -H "Authorization: Bearer YOUR_API_KEY"
```

## Active API families

* Copywriter jobs and Autopilot
* Reporter tracking projects, scans, results, trends, and summaries
* Researcher jobs and projects
* Clients
* Optimize and Page Auditor
* Search Intelligence
* Scrape, Crawl, and Extract
* Published Help Center knowledge base

## Rate limits

| Public plan | Requests per minute |
| ----------- | ------------------- |
| Solo        | 30                  |
| Core        | 30                  |
| Team        | 60                  |
| Agency      | 120                 |

Handle `429` responses and use returned rate or quota headers instead of hard-coding one limit.

## Next

* [Authentication and scopes](/api/api-authentication.md)
* [Credits, rate limits, and errors](/api/api-credits-rate-limits-and-errors.md)
* [Researcher API](/api/api-researcher.md)
* [Scrape, Crawl, and Extract API](/api/api-crawler.md)


---

# 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-getting-started.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.