Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Dashboard at any time.

The best way to interact with our API is to use one of our official libraries:

Make your first request

To make your first request, send an unauthenticated request to the check endpoint. This will return the status, which is nice. :)

Check the API is online.

GET https://random.theprocut.co.uk/api/v1/check

Allows you to see if the API is online

200 System Online

{
    "system-online": "True"
}

Good to know: The most common issues with our APIs are that they are offline, consider adding this before sending your request.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://random.theprocut.co.uk/api/v1/check

Python