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

# Introduction

<Check>
  The PROlinks REST API is only available on the PRO plan.
</Check>

The PROlinks API allows you to create and interact with links and resources on PROlinks through a simple REST API.

## Authentication

In order to use the API, you should authenticate your request by including your API key as a bearer token value:

```html theme={null}
Authorization: Bearer API_KEY_HERE
```

You may generate your API key in the API Dashboard.

## Headers

Make sure you have the following content type headers set on every request:

```html theme={null}
    Accept: application/json
    Content-Type: application/json
```

## URI

PROlinks API is hosted on the following base URI:

```html theme={null}
    https://prolinks.pro/api/v1
```

## Errors

PROlinks uses conventional HTTP response codes to indicate the success or failure of an API request. The table below contains a summary of the typical response codes:

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>200</td>
      <td>Everything is ok.</td>
    </tr>

    <tr>
      <td>400</td>
      <td>Valid data was given but the request has failed.</td>
    </tr>

    <tr>
      <td>401</td>
      <td>No valid API Key was given.</td>
    </tr>

    <tr>
      <td>404</td>
      <td>The request resource could not be found.</td>
    </tr>

    <tr>
      <td>422</td>
      <td>The payload has missing required parameters or invalid data was given.</td>
    </tr>

    <tr>
      <td>429</td>
      <td>Too many attempts.</td>
    </tr>

    <tr>
      <td>500</td>
      <td>Request failed due to an internal error in PROlinks.</td>
    </tr>

    <tr>
      <td>503</td>
      <td>PROlinks is offline for maintenance.</td>
    </tr>
  </tbody>
</table>