> 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-use-cases.md).

# API use cases and integration patterns

Build reliable content, research, tracking, audit, and crawler workflows with least-privilege scopes, polling, idempotency, and plan-aware throttling.

## Bulk content workflow

1. Read keywords and client IDs from your system.
2. Create one Copywriter job per intended item with an idempotency key.
3. Store each job ID.
4. Poll with backoff until a terminal state.
5. Retrieve artifacts and send them to human review or a CMS draft.

## Research workflow

Create Researcher jobs with `researcher:run`, poll with `researcher:read`, and save only the keywords your downstream process needs.

## Reporting workflow

Use `reporter:read` for dashboards. Add `reporter:run` only when the integration must start scans and `reporter:write` only when it must manage projects.

## Audit and crawler workflow

Use Page Auditor for a scored asynchronous page audit. Use Scrape for one fetched page, Crawl for a bounded asynchronous crawl, and Extract for a successful structured extraction.

## Reliability rules

* Use the smallest scope set.
* Use idempotency for supported create calls.
* Poll asynchronous jobs with backoff.
* Handle `429` from returned headers; limits are 30 requests/min for Solo/Core, 60 for Team, and 120 for Agency.
* Check whether a job exists before retrying a write.
* Do not publish generated material without the review your workflow requires.


---

# 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-use-cases.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.