# Integration Overview

## Overview <a href="#overview" id="overview"></a>

Our API uses the OpenAPI 2.0 specification, making it easy for our partners to integrate. We want to ensure the best possible experience when integrating with our stack.

### Environments <a href="#environments" id="environments"></a>

| Environment   | URL                          |
| ------------- | ---------------------------- |
| Production V2 | `https://api.autograb.co.uk` |

### Regions <a href="#regions" id="regions"></a>

Certain API endpoints require that a region be passed as part of the request URL. Where necessary it is expected that region=uk be included where region is required.

For example: `https://api.autograb.co.uk/v2/vehicle/3190324654943863?region=uk`

#### Supported Regions <a href="#supported-regions" id="supported-regions"></a>

| Country        | Region Code |
| -------------- | ----------- |
| United Kingdom | `uk`        |

### API Keys <a href="#api-keys" id="api-keys"></a>

Your account manager will provision API keys for your account. If you require a key to be revoked please get in touch with your account manager.

### Quota Limits <a href="#quota-limits" id="quota-limits"></a>

APIs have soft quota limits that are enforced based on your contract agreement. To discuss these limits please get in touch with your account manager.

#### Rate Limiting <a href="#rate-limiting" id="rate-limiting"></a>

We strictly monitor the number of requests per second — if you exceed your allocation the API will respond with `HTTP 429 Too Many Requests`. We will also return additional headers to help you better understand when rate limits will be applied.

The limits are applied per API product and are decided based on your contract agreement. Rate limits do not relate to quotas.

| Header                       | Example      | Description                                                         |
| ---------------------------- | ------------ | ------------------------------------------------------------------- |
| `Rate-Limit-Remaining`       | `60`         | Number of remaining requests until the limit is reset.              |
| `Rate-Limit-Total`           | `60`         | Number of total requests that can be made until the limit is reset. |
| `Rate-Limit-Reset`           | `1609459200` | The timestamp of when the limit will reset.                         |
| `Monthly-Base-Request-Quota` | `100`        | Number of requests included in your contract.                       |
| `Monthly-Max-Request-Quota`  | `100000`     | Maximum number of requests allowed in your contract.                |
| `Monthly-Request-Total`      | `100`        | Monthly requests performed for this request type.                   |


---

# Agent Instructions: 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:

```
GET https://devhub.autograb.com/uk-autograb-api-doc/autograb-basics/integration-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
