Reader API Documentation

Complete guide to using the Reader API to clean and generate content from any URL using your own Google Gemini API key.

Quick Start

Get started with the Reader API in minutes. Clean and generate content from URLs using your Gemini API key.

1. Obtain your Gemini API Key

Get a Gemini API key from Google AI Studio: https://aistudio.google.com/apikey

2. Make your first request - Clean Content

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_GEMINI_API_KEY" \
-d '{"targetUrl": "YOUR_URL_HERE"}' \
"https://v1.readerapi.com/clean"

3. Make your first request - Generate Content

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_GEMINI_API_KEY" \
-d '{"targetUrl": "YOUR_URL_HERE", "prompt": "Summarize this content"}' \
"https://v1.readerapi.com/generate"

Authentication

All API requests require authentication using your own Gemini API key, provided in the request headers.

Authorization Header

Authorization: Bearer YOUR_GEMINI_API_KEY

You must obtain your own API key from Google AI Studio and include it in every request. This API acts as a wrapper, utilizing your Gemini API key to process content.

Keep your Gemini API key secure and never expose it publicly.

API Endpoints

Clean Content from URL

POST/clean

Request Headers

Authorization: Bearer YOUR_GEMINI_API_KEY

- Your Gemini API key (required).

```
Content-Type: application/json
```
- Specifies JSON request body.

Request Body

```
targetUrl
```
- The URL to clean (required).
```
model
```
- Gemini model (optional, default: "gemini-2.0-flash"). See Gemini Models.

Response

Returns cleaned content in Markdown format.

Generate Content from URL

POST/generate

Request Headers

Authorization: Bearer YOUR_GEMINI_API_KEY

- Your Gemini API key (required).

```
Content-Type: application/json
```
- Specifies JSON request body.

Request Body

```
targetUrl
```
- The URL to process (required).
```
prompt
```
- Custom prompt to guide generation (required).
```
model
```
- Gemini model (optional, default: "gemini-2.0-flash"). See Gemini Models.

Response

Returns generated content in Markdown format as a stream.

Gemini Models

The following Gemini models are supported:

gemini-2.0-flash (default)
gemini-2.0-flash-lite-preview-02-05
gemini-2.0-pro-exp-02-05
gemini-2.0-flash-thinking-exp-01-21
gemini-2.0-flash-exp

Health Check

GET/health

Response

Returns the API's health status and server timestamp.

{
  "status": "ok",
  "timestamp": "2024-02-17T12:00:00.000Z"
}

Response Formats

Markdown Format

# Cleaned/Generated Content Title

## Section 1

Content of section 1 in markdown.

## Section 2

More content...

- List item 1
- List item 2

The API returns content in structured Markdown.

Error Handling

Error Codes

text inline 400
- Bad request (invalid parameters).
text inline 401
- Unauthorized (invalid/missing Gemini API key).
text inline 429
- Rate limit exceeded (your Gemini API key's limits).
text inline 500
- Internal server error.

Error Response Format

{
  "error": {
    "code": 401,
    "status": "UNAUTHORIZED",
    "message": "Missing or invalid Authorization header...",
    "action": "Include valid Bearer token..."
  }
}

Rate Limits

Request Limits

Rate limits are governed by your Google Gemini API key's quota. Refer to Google AI Studio for your usage limits.
This Reader API may introduce its own limits in the future.

Pricing

Free to Use (Gemini API Cost Applies)

Reader API Usage Cost

• Free usage of Reader API
• Clean & Generate Endpoints
• Community support
• Standard API access
• Requires your own Gemini API key

Reader API is free. You are responsible for costs associated with your Google Gemini API usage. Refer to Google AI Studio for Gemini API pricing.

Ready to Get Started?

Start cleaning and generating content from URLs today with the Reader API.