Getting Started for Developers (API Quickstart)

3 min

This guide will show you how to anonymize your first photo programmatically using the MaskIT API. We'll make a single, simple API call to get you started in under 30 seconds.

Step 1: Prerequisites

Before you begin, you will need two things:

A MaskIT Account: If you don't have one, sign up at https://app.maskit.ai/.
Your API Key: You can find or generate your API key in the Account -> API access section of the web application.
Select the pencil icon ✏️ and click on Regenerate API Key

More information you can find on 🔐 API Key & Webhook Secret.

Step 2: Make Your First API Call

The easiest way to test the API is using cURL. This command uploads a local image named example.jpg, anonymizes it using the default settings, and prints the jobId of the new anonymization task.

There are three main endpoints:

Process Image: Upload an image for asynchronous processing. Returns a jobId immediately. The image is masked in the background.
Image Status: Check the current status of a previously submitted masking job. Useful for polling.
Image Download: Retrieve the final masked image once processing is complete and ready.

For a complete overview of all available parameters and advanced features, please dive into our full 🔌API & Integration.