[v3beta] Smarter-1 Marketplace API
Smarter-1 is the first-ever AI model built for CPG compliance teams. It allows you to enrich large product catalogs with smarter classifications, instantly, and at scale. Please visit the Getting Started page (in the menu) to learn more about the underlying concepts and workflow.
https://api.smarterx.comAuthentication
docs
OpenAPI spec
GET - OpenAPI spec
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
smarter-1
GET - Decisions
Retrieve a list of decisions that can apply to a product. You can use any of these decision names in your classification job request payload to retrieve specific decision ouputs for your product.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
expand
Expand the response to include the specified details about the decisions.
Possible Enum Values
recommended_product_attributes
1
GET - List Classification Jobs
List previously requested product clasification job(s).
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
page_size
The size of each page of job results
page_token
A page token, received from a previous call to this endpoint. Provide this to retrieve the subsequent page.
1
POST - Initialize Product Classification Job
Invoke an asynchronous job to classify between 1-25 products based on available product attributes.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
The input payload for the product classification job.
products
decisions_to_evaluate
1
{
"products": [
{
"flashpoint": "120F",
"brand": "Well Known Name Brand",
"ingredients_list": [
"Ethanol",
"Water",
"Phosphorous"
]
}
],
"decisions_to_evaluate": [
"RCRA_WASTE",
"STORAGE"
]
}GET - Status of Product Classification Job
Poll the current status of a product clasification job.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
job_id
The job id of the classification job
1
Search
Pass a json body to search for things
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
Elasticsearch search query in JSON format
Unnamed Property
1
{
"query": {
"match": {
"taxonomy": "carpet spot cleaning sprays"
}
}
}