πAPI & Integration
π 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 https //docs maskit ai/process image endpoint 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 succeeded job completed and post processing (e g webhook, image download) succeeded 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