{ "info": { "_postman_id": "a392b685-e759-499a-b5a6-5543b0003e3e", "name": "Mindee Crop API", "description": "Detect, crop, and isolate the document area inside a larger scanned image before further processing.\n\nContact Support:\n Name: Mindee", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:12:35.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "lastUpdatedBy": "35240", "uid": "35240-a392b685-e759-499a-b5a6-5543b0003e3e" }, "item": [ { "name": "v2", "item": [ { "name": "products", "item": [ { "name": "crop", "item": [ { "name": "enqueue", "item": [ { "name": "Send A File For A Crop Utility Inference", "id": "bb88d268-6dfa-4a5b-8120-e5f55d2e6cf2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Model ID to use for the inference.", "key": "model_id", "value": "", "type": "text" }, { "key": "file", "type": "file", "value": null }, { "key": "url", "value": "", "type": "text" }, { "key": "file_base64", "value": "", "type": "text" }, { "description": "Webhook IDs to call after all processing is finished. If empty, no webhooks will be used. Can be a list or comma-separated string.", "key": "webhook_ids", "value": ",", "type": "text" }, { "key": "filename", "value": "", "type": "text" }, { "key": "alias", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/products/crop/enqueue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "enqueue" ] }, "description": "Send a file to the asynchronous processing queue for a crop utility inference.\n\nResults can be retrieved in two ways:\n* Loop on the `polling_url` endpoint in the response until the status\n is `Processed` or `Failed` (polling).\n* Use a webhook to be notified when the inference is finished.\n Webhooks can be configured on the platform on a per-model basis.\n\nInferences taking longer than 590 seconds will time out." }, "response": [ { "id": "3b4715d3-a8b3-47f8-8003-79cf39cfdf16", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Model ID to use for the inference.", "key": "model_id", "value": "", "type": "text" }, { "key": "file", "type": "file" }, { "key": "url", "value": "", "type": "text" }, { "key": "file_base64", "value": "", "type": "text" }, { "description": "Webhook IDs to call after all processing is finished. If empty, no webhooks will be used. Can be a list or comma-separated string.", "key": "webhook_ids", "value": ",", "type": "text" }, { "key": "filename", "value": "", "type": "text" }, { "key": "alias", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/products/crop/enqueue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "enqueue" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"job\": {\n \"id\": \"\",\n \"model_id\": \"\",\n \"filename\": \"\",\n \"created_at\": \"\",\n \"status\": \"Processed\",\n \"polling_url\": \"\",\n \"alias\": \"\",\n \"completed_at\": \"\",\n \"result_url\": \"\",\n \"error\": {\n \"status\": \"\",\n \"detail\": \"\",\n \"title\": \"\",\n \"code\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-3b4715d3-a8b3-47f8-8003-79cf39cfdf16" }, { "id": "adf6c2bd-eb94-4cd5-aa12-1fe0fde543d4", "name": "Unprocessable Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Model ID to use for the inference.", "key": "model_id", "value": "", "type": "text" }, { "key": "file", "type": "file" }, { "key": "url", "value": "", "type": "text" }, { "key": "file_base64", "value": "", "type": "text" }, { "description": "Webhook IDs to call after all processing is finished. If empty, no webhooks will be used. Can be a list or comma-separated string.", "key": "webhook_ids", "value": ",", "type": "text" }, { "key": "filename", "value": "", "type": "text" }, { "key": "alias", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/products/crop/enqueue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "enqueue" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"detail\": \"\",\n \"title\": \"\",\n \"code\": \"\"\n}", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-adf6c2bd-eb94-4cd5-aa12-1fe0fde543d4" }, { "id": "cc688c0e-0a71-4063-a4bc-6ba4da56558b", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Model ID to use for the inference.", "key": "model_id", "value": "", "type": "text" }, { "key": "file", "type": "file" }, { "key": "url", "value": "", "type": "text" }, { "key": "file_base64", "value": "", "type": "text" }, { "description": "Webhook IDs to call after all processing is finished. If empty, no webhooks will be used. Can be a list or comma-separated string.", "key": "webhook_ids", "value": ",", "type": "text" }, { "key": "filename", "value": "", "type": "text" }, { "key": "alias", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/products/crop/enqueue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "enqueue" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"detail\": \"\",\n \"title\": \"\",\n \"code\": \"\"\n}", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-cc688c0e-0a71-4063-a4bc-6ba4da56558b" } ], "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-bb88d268-6dfa-4a5b-8120-e5f55d2e6cf2" } ], "id": "5f2e955c-5fa7-406b-a591-33651c06db6d", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-5f2e955c-5fa7-406b-a591-33651c06db6d" }, { "name": "results", "item": [ { "name": "{inference_id}", "item": [ { "name": "Get The Result Of A Completed Crop Product Inference", "id": "6b7bc624-130e-484c-8482-5872f0fd2c83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/products/crop/results/:inference_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "results", ":inference_id" ], "variable": [ { "id": "1b440cf1-856b-41d7-8646-9b4c58e2aeba", "key": "inference_id", "value": "", "description": "(Required) UUID of the inference to retrieve" } ] }, "description": "Get the result of a crop utility inference that was previously enqueued.\n\nThe inference will only be available after it has finished processing.\n\nIf you are using webhooks there is no need to call this route.
\nHowever, the JSON payload described here is what will be sent to each specified webhook's URL.\n\nIf you activated the \"Delete extracted data when fetched\" option for the model,\nthe inference will be deleted after this route completes.
\nAny further requests to the same inference ID will return a 404." }, "response": [ { "id": "842e811f-e2d6-48d8-86eb-7b8c9dc28fbe", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/products/crop/results/:inference_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "results", ":inference_id" ], "variable": [ { "key": "inference_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"inference\": {\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"model\": {\n \"id\": \"\"\n },\n \"file\": {\n \"name\": \"\",\n \"page_count\": \"\",\n \"mime_type\": \"\",\n \"alias\": \"\"\n },\n \"result\": {\n \"crops\": [\n {\n \"object_type\": \"\",\n \"location\": {\n \"polygon\": [\n \"\",\n \"\",\n \"\"\n ],\n \"page\": \"\"\n },\n \"extraction_response\": {\n \"inference\": {\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"model\": {\n \"id\": \"\"\n },\n \"file\": {\n \"name\": \"\",\n \"page_count\": \"\",\n \"mime_type\": \"\",\n \"alias\": \"\"\n },\n \"result\": {\n \"fields\": {\n \"nulla_9f\": {\n \"value\": \"\",\n \"confidence\": \"Certain\"\n }\n },\n \"raw_text\": {\n \"pages\": [\n {\n \"content\": \"\"\n },\n {\n \"content\": \"\"\n }\n ]\n },\n \"rag\": {\n \"retrieved_document_id\": \"\"\n }\n },\n \"active_options\": {\n \"raw_text\": \"\",\n \"polygon\": \"\",\n \"confidence\": \"\",\n \"rag\": \"\",\n \"multipage_context\": \"\",\n \"text_context\": \"\",\n \"data_schema\": {\n \"replace\": \"\"\n }\n }\n }\n }\n },\n {\n \"object_type\": \"\",\n \"location\": {\n \"polygon\": [\n \"\",\n \"\",\n \"\"\n ],\n \"page\": \"\"\n },\n \"extraction_response\": {\n \"inference\": {\n \"id\": \"\",\n \"job\": {\n \"id\": \"\"\n },\n \"model\": {\n \"id\": \"\"\n },\n \"file\": {\n \"name\": \"\",\n \"page_count\": \"\",\n \"mime_type\": \"\",\n \"alias\": \"\"\n },\n \"result\": {\n \"fields\": {\n \"minimf8\": {\n \"value\": \"\",\n \"confidence\": \"Certain\"\n }\n },\n \"raw_text\": {\n \"pages\": [\n {\n \"content\": \"\"\n },\n {\n \"content\": \"\"\n }\n ]\n },\n \"rag\": {\n \"retrieved_document_id\": \"\"\n }\n },\n \"active_options\": {\n \"raw_text\": \"\",\n \"polygon\": \"\",\n \"confidence\": \"\",\n \"rag\": \"\",\n \"multipage_context\": \"\",\n \"text_context\": \"\",\n \"data_schema\": {\n \"replace\": \"\"\n }\n }\n }\n }\n }\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-842e811f-e2d6-48d8-86eb-7b8c9dc28fbe" }, { "id": "54d20796-fe24-44e9-b478-df2fe6fa7f09", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/products/crop/results/:inference_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "results", ":inference_id" ], "variable": [ { "key": "inference_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"detail\": \"\",\n \"title\": \"\",\n \"code\": \"\"\n}", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-54d20796-fe24-44e9-b478-df2fe6fa7f09" }, { "id": "8c253437-1925-4a18-a40d-efc1327d9a20", "name": "Unprocessable Content", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/products/crop/results/:inference_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "products", "crop", "results", ":inference_id" ], "variable": [ { "key": "inference_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"detail\": \"\",\n \"title\": \"\",\n \"code\": \"\"\n}", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-8c253437-1925-4a18-a40d-efc1327d9a20" } ], "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-6b7bc624-130e-484c-8482-5872f0fd2c83" } ], "id": "6414c207-3f20-4a5a-99a4-e01920b0b5f4", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-6414c207-3f20-4a5a-99a4-e01920b0b5f4" } ], "id": "bc665bf2-4395-468d-bcd8-3f13a21592cc", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-bc665bf2-4395-468d-bcd8-3f13a21592cc" } ], "id": "546bf9c7-9172-4b60-9b16-cf5087ab4883", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-546bf9c7-9172-4b60-9b16-cf5087ab4883" } ], "id": "8ece5a1e-ab17-4d0a-abd1-b35efe2ece26", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-8ece5a1e-ab17-4d0a-abd1-b35efe2ece26" } ], "id": "15a66dec-f16e-4996-abb1-4e12abbc6c99", "createdAt": "2026-06-05T15:12:36.000Z", "updatedAt": "2026-06-05T15:12:36.000Z", "uid": "35240-15a66dec-f16e-4996-abb1-4e12abbc6c99" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api-v2.mindee.net" } ] }