> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arxivgpt.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the arXivGPT Paper API, a developer-friendly solution for converting arXiv papers to Markdown or plain text formats.

<img className="block dark:hidden" src="https://mintcdn.com/arxivgpt/m5RCuB3dqQeljGYe/images/hero-light.png?fit=max&auto=format&n=m5RCuB3dqQeljGYe&q=85&s=ef0c49442a52e38d534bf517d710be4e" alt="arXivGPT API Light Mode" width="2277" height="2010" data-path="images/hero-light.png" />

<img className="hidden dark:block" src="https://mintcdn.com/arxivgpt/m5RCuB3dqQeljGYe/images/hero-dark.png?fit=max&auto=format&n=m5RCuB3dqQeljGYe&q=85&s=942d39cd3cd376c01870920f81ea676f" alt="arXivGPT API Dark Mode" width="2277" height="2010" data-path="images/hero-dark.png" />

## 👋 Overview

The arXivGPT Paper API offers a powerful solution for converting any arXiv paper into Markdown or plain text formats. Allowing you the following:

* Power AI agents with structured scientific content
* Build custom applications leveraging arXiv paper data
* Enhance research workflows and data analysis
* Explore and experiment with scientific literature in machine-readable formats

## 🚀 Getting Started

Our API is powered by RapidAPI, ensuring a smooth and secure integration process. Follow these simple steps to get started:

1. **Obtain API Credentials**:
   * Subscribe to our API and get your key from [RapidAPI](https://rapidapi.com/arxivgpt-arxivgpt-default/api/arxivgpt).

2. **Prepare Your Request**:
   * Add your RapidAPI credentials to the request header:
     * `x-rapidapi-key`
     * `x-rapidapi-host`
   * Include query parameters:
     * `paper_id` (required): The arXiv paper identifier
     * `num_pages` (optional): Number of pages to return

3. **Make the API Call**:
   * Choose between Markdown or plain text endpoints
   * Execute your request and receive the converted paper data

## 💻 Code Examples

Here are sample code snippets to help you get started quickly:

<CodeGroup>
  ```python Markdown theme={null}
  import requests

  url = "https://arxivgpt.p.rapidapi.com/papers/markdown/"
  querystring = {"paper_id": "2408.01800", "num_pages": "5"}
  headers = {
      "x-rapidapi-key": "<YOUR_RAPIDAPI_KEY>",
      "x-rapidapi-host": "<YOUR_RAPIDAPI_HOST>"
  }

  response = requests.get(url, headers=headers, params=querystring)
  print(response.text)
  ```

  ```python Plain Text theme={null}
  import requests

  url = "https://arxivgpt.p.rapidapi.com/papers/text/"
  querystring = {"paper_id": "2408.01800", "num_pages": "5"}
  headers = {
      "x-rapidapi-key": "<YOUR_RAPIDAPI_KEY>",
      "x-rapidapi-host": "<YOUR_RAPIDAPI_HOST>"
  }

  response = requests.get(url, headers=headers, params=querystring)
  print(response.text)
  ```
</CodeGroup>

## 📊 API Response

Our API returns the converted paper content along with metadata. Here's a sample response structure:

```json theme={null}
{
  "paper_id": "2408.01800",
  "content": "# Introduction\n\nThis is the converted paper content...",
  "format": "markdown",
  "pages_returned": 5,
  "total_pages": 15
}
```

## 🛠 Use Cases

1. **Build AGI**: Power your AGI with structured scientific content
2. **AI-Powered Literature Review**: Train models on structured paper data for automated summarization and analysis.
3. **Custom Search Engines**: Build specialized search tools for scientific literature.
4. **Data Visualization**: Create interactive visualizations of research trends and connections.
5. **Accessibility Tools**: Convert papers to more accessible formats for screen readers or text-to-speech applications.

## 📈 Pricing and Limits

Visit our [RapidAPI page](https://rapidapi.com/arxivgpt-arxivgpt-default/api/arxivgpt) for up-to-date information on:

* Free tier limitations
* Paid plan options
* Rate limits and usage quotas

## 🤝 Support and Feedback

We're committed to providing an excellent developer experience:

* Join our [Discord community](https://discord.gg/86efjr3a6f) for real-time support and discussions.

We love developer feedback and are constantly working to improve our API. Let us know how we can serve you better!