Image Processing Request

Create Image Processing Request

Category: Requests

Description: Creates a processing request for an image send in the request body

Method: POST

URL: https://processing.studio.liftdata.ai/requests

Headers

Name	Type	Required?	Description
X-API-KEY	string	Yes	Obtained through Studio. Must be passed with each request

Body Params

Name	Type	Required?	Description
model_id	string	Yes	UUIDv4 ID of a model that will be used to extract data from the image
image	File	Yes	File with the image that should be used for processing
config_name	string	No	Name of the configuration that will be used to extract data from the image. If not specified we will try to auto-detect respective configuration
payload	string	No	JSON encoded string that can be used to pass any extra information with the image. Data from it can later be used to filter and/or aggregate extracted data from the images

Responses

Code	Response body
201	{ "id": "3b66cb89-c950-4e1c-a7e6-cea13410f239", "status": "processing", "created_at": "2024-10-14T20:37:07.444877", "reason": null, "processed_at": null, "config_model": null, "result_data": null, "payload_data": null, "model_id": "802e9e17-8141-4114-9ee5-733210a66f39", "model_config_id": null }
401	{ "detail": "Not authenticated" }
404	{ "detail": "Model with this id does not exist." }
422	{ "detail": [ { "type": "missing", "loc": [ "body", "image" ], "msg": "Field required", "input": null } ] }