Get started

Create an API token

To create an API token:

Sign in
Go to your account settings
Click "Regenerate API token"
Copy the Token and store it safely

Account settings

Making a request

To make a request please use https://previewlinks.io/api/v1/ as base URL for all your requests.

Don't forget to add the necessary headers:

Authorization: Bearer <YOUR_API_TOKEN>
Accept: application/json
Content-Type: application/json

We assume you'll send any data required for the endpoints as JSON.

Rate limiting

To avoid spamming we've added rate limits to our API, these are the limits per plan, per minute:

Starter: 30
Business: 60
Unlimited: 120

Error handling

A validation error will look like this:

{
  "message": "The given data was invalid.",
  "errors": {
    "fields": [
      "The fields given do not match the required ones, required fields: previewlinks:title and previewlinks:subtitle."
    ]
  }
}

Successful responses will return a 200 status code.