> 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-optimize-endpoint.md).

# Optimize API endpoint

Score a public URL against search competitors with the customer Agent API and the optimize:run scope.

## Endpoint

```
POST https://rankability.com/api/agent/v1/optimize
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## Scope and cost

The key needs `optimize:run`. A successful call costs 1,200 credits. Rankability applies idempotency to the same URL and keyword combination within the applicable billing window.

## Request

```
{
  "url": "https://example.com/your-page",
  "keyword": "target keyword",
  "language": "en-US"
}
```

`url` and `keyword` are required. The URL must be public HTTP or HTTPS; private networks, localhost, link-local addresses, and cloud metadata hosts are blocked.

## Response

The synchronous response includes the Rankability score, entity coverage, keyword placement, extracted entities, competitor summary, source word count, and duration. A call can take tens of seconds because it retrieves search results and public pages.

## Errors

* `400` for invalid or unsafe input.
* `401` for invalid authentication.
* `403` for a missing scope.
* `402` for insufficient credits.
* `429` for a rate limit.

Use the Agent API route above for customer integrations. Internal Rankability routes and admin credentials are not part of the customer contract.


---

# 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-optimize-endpoint.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.