🔌API & Integration

4 min

Welcome to the MASKIT API & Integration hub. This section provides developers with everything needed to integrate MASKIT’s intelligent image masking capabilities into external systems via secure API calls and optional webhook notifications.

You can submit an image for asynchronous masking, poll for its processing status, and retrieve the final masked image - all via a secure and developer-friendly API.

📍 Available Endpoints

Below are the core endpoints that power the MASKIT image masking pipeline:

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.
Webhook: Set useWebhook=true during submission to receive a multipart/form-data POST to your endpoint upon completion. This is ideal for integrating MASKIT into fully automated pipelines.

🔐 Authentication

All API requests require an API key, and optionally a shared webhook secret for verifying signed payloads.

👉 Learn how to obtain yours here: API Key & Webhook Secret

🧩 Need Help?

Not sure how to set up polling vs. webhook flow? Need help handling image uploads or validating webhook signatures? We're here to help - reach out to our team at [email protected].