Guides

Get Categorization Job Status and Mappings

Learn how to get the status of a categorization job with the Smart Categorization API.

EndpointMethodRequired fields
/public-api/categorize/status/{jobId}GETjobId

Use this request to get the status and result of a categorization job.

Sample response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientVertexId": "3fa85f64-5717-4562-b3fc-2c963f66afa60",
  "startTime": "2025-04-05T00:32:09.658716Z",
  "endTime": "2025-04-05T00:33:12.436823Z",
  "persistent": true,
  "numProducts": 1,
  "numIssues": 0,
  "blobUri": "https://<example>.blob.core.windows.net/client2/jobOutputs/consolidated/c8c69bbc-ccbc-400e-a0d1-402adf2ffcf4/job-c8c69bbc-ccbc-400e-a0d1-402adf2ffcf4-consolidated.json",
  "retentionDays": 30,
  "result": [
    {
      "index": 1,
      "Name": "Bread & Butter Sliders",
      "Reasoning": "...",
      "Category": "Vegetables",
      "Confidence": 0.99,
      "product_unique_id": "009300002875-test",
      "web_search_enrichment": "Mt Olive Bread & Butter Sliders, Old Fashioned Sweet 24 Fl Oz\nIngredients. Cucumbers, Sugar, Water, Vinegar, Sea Salt, Mustard Seeds, Onion Flakes, Calcium Chloride (Firming Agent), Celery Seeds, Polysorbate 80, and ...",
      "llm_confidence": "extremely confident",
      "mdu_version_used_by_engine_for_categorization": "254",
      "used_existing_mapping": false
    }
  ],
  "status": "DONE"
}