📊 Image Status Endpoint
10 min
The Image Status endpoint allows you to check the processing status of a previously submitted image masking job using the jobId returned by the Process Image endpoint.
This is useful for polling-based integrations, where your system periodically checks whether the job has completed.
📦 Endpoint Overview
- URL: GET https://app.maskit.ai/api/v1/masking/image-status
- Authentication: X-Api-Key header (required)
- Response: JSON object describing the current job status
- Use Case: Polling for progress on asynchronous masking jobs
📝 Query Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
jobId | string | ✅ | The unique identifier of the submitted job |
🔐 Authentication
Include your API key in the request header:
X-Api-Key: YOUR_API_KEY
🔁 Response
Success (200 OK)
{
"jobId": "9f52f3d9-1c84-4b1d-bf7c-2f0b9383fa17",
"status": "InProgress"
}Possible Status Values:
- Pending: Job is queued but not yet started.
- InProgress: Job is currently being processed.
- ReadyToDownload: Image is processed and ready for download.
- Completed: Job completed and post-processing (e.g. webhook, image download) succeeded.
- TimedOut: Job did not complete within the allowed time window and was automatically terminated.
- Failed: An error occurred during processing.
Error Responses:
Code | Description |
|---|---|
400 | Missing or invalid job ID |
401 | Missing or invalid API key |
404 | Job not found or does not belong to the authenticated user |
500 | Internal server error |
🚀 Example cURL Request
curl -X GET "https://app.maskit.ai/api/v1/masking/image-status?jobId=YOUR_JOB_ID" \
-H "X-Api-Key: YOUR_API_KEY"This command checks the current status of your submitted masking job.