Using the Smart Categorization API

You can use the Smart Categorization API to upload a list of product files for categorization and check the status of categorization jobs.

Getting started

Before you can send API requests, you need to retrieve your access token. Read the Authentication topic for more information.

API overview

The API URL is https://smartcategorization.vertexcloud.com/public-api.

The API consists of the following components:

Endpoint	Endpoint request	Endpoint description
`/categorize`	Create categorization	Starts a categorization job.
`/categorize/persist`	Create persistent categorization	Starts a persistent categorization job.
`/categorize/status/{jobId}`	Get categorization job status and mappings	Checks the status of a categorization job.
`/allproduct/all-product-mappings`	Retrieve all product mappings	Retrieves all available product mappings.
`/categorize/sync`	Classify products synchronously	Classifies exactly one product synchronously and returns the result immediately without persisting product data.
`/categorize/persist/sync`	Classify and persist products synchronously	Classifies exactly one product synchronously, persists the result, and returns the classification result for the submitted product.

Using the API

The following sections detail how you can use the API.

Create categorization

You can use the Create categorization request to start a categorization job. The response includes a job ID that you can use to retrieve results. The results of a categorization job do not persist in the application.

Create persistent categorization

You use the Create persistent categorization request to start a persistent categorization job. The response includes a job ID that you can use to retrieve results. The results of a persistent categorization job persist in the application. You can log in to your Smart Categorization instance to review or modify the results.

Get categorization job status and mappings

You use the Get categorization job status and mappings request to check the status of a categorization job and review results.

Retrieve all product mappings

You use the Retrieve all product mappings request to retrieve all product category mappings. You can filter the response using multiple fields.

Classify products synchronously

You use the Classify products synchronously request to classify one product and return the result immediately. The product data and classification result are not persisted.

Classify and persist products synchronously

You use the Classify and persist products synchronously request to classify one product and persist the result. You can retrieve or modify the persisted result later.