> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://support.thumbnailtest.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Accessing the ThumbnailTest API

This guide explains how to access and use the ThumbnailTest API to integrate thumbnail testing into your workflow.

## Prerequisites

To use the ThumbnailTest API, you need an active **Pro** or **Business** subscription. If you are on a different plan, please upgrade your subscription first.

## Getting Your API Key

Your API key authenticates your requests to the ThumbnailTest API. Follow these steps to generate your key:

1. Log in to your ThumbnailTest account at [https://app.thumbnailtest.com](https://app.thumbnailtest.com).
2. Navigate to your **Team Settings** page: [https://app.thumbnailtest.com/settings/team](https://app.thumbnailtest.com/settings/team).
3. In the API Keys section, generate a new API key.
4. **Important:** Copy your API key immediately and store it securely. You won't be able to see it again after you navigate away from the page.

Treat your API key like a password. Do not share it publicly or commit it to version control.

## API Endpoint

All API requests should be sent to the following base URL:

```
https://api.thumbnailtest.com/docs
```
Refer to our [API Documentation](https://api.thumbnailtest.com/docs) (accessible once you are logged in or via the main API endpoint) for details on available endpoints, request formats, and responses.

## Authentication

Include your API key in the `Authorization` header of your requests, using the `Bearer` scheme:

```
Authorization: Bearer YOUR_API_KEY
```

Replace `YOUR_API_KEY` with the actual key you generated.

## Rate Limits

The API enforces rate limits based on your subscription plan to ensure fair usage:

* **Pro Plan:** 300 requests per hour
* **Business Plan:** 5000 requests per hour

If you exceed these limits, you will receive a `429 Too Many Requests` error response. Ensure your integration handles these potential errors gracefully.

## Improvements

If you have any suggestions for any endpoints that you'd like added please create an idea on our roadmap at https://roadmap.thumbnailtest.com/

## Support

If you have any questions or encounter issues while using the API, please contact our support team at [support@thumbnailtest.com](mailto:support@thumbnailtest.com).