Using the Smart Categorization API
Read about how to use 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.
The API consists of the following components:
| Endpoint | Request | Description |
|---|---|---|
/categorize | Create Categorization | Start a categorization job. |
/categorize/persist | Create Persistent Categorization | Start a persistent categorization job. |
/categorize/status/{jobId} | Get Categorization Job Status | Check the status of a categorization job. |
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 which you can use to retrieve results. The results of a categorization job are not persisted 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 which you can use to retrieve results. The results of a persistent categorization job are persisted in the application. You can log in to your Smart Categorization instance to review or modify the results.
Get Categorization Job Status
You use the Get Categorization Job Status request to check the status of a categorization job and review results.
Updated 29 days ago