The Smart Decision Engine API enables companies to address complex allocation and optimization problems by evaluating elements according to specific requirements and custom constraints. Ideal for maximizing benefits and minimizing costs, this API integrates advanced functionality such as criteria weighting, penalties for constraint violations, and dynamic adjustments based on custom parameters. With applications in industries such as logistics, finance, e-commerce and more, this tool offers robust solutions that adapt to different workflows. Simplify critical decisions, save time and resources, and allow developers to focus on innovating and solving strategic problems.
Send a POST request with elements and assignments in the body.Receive optimal solutions based on customized constraints, with detailed explanations of scores.
Optimize Allocation - Endpoint Features
| Object | Description |
|---|---|
Request Body |
[Required] Json |
[{"itemAssignments":[{"id":"1","requirements":[{"type":"item.color","scoringLogic":{"method":"Penalize","comparisonLogic":"NotEqual","weight":10,"constraintHardness":"hard","weightRelativePercentage":1.0},"values":["Blue"],"valueType":"string","penalty":10,"penaltyPercentage":0.5}],"budget":{"amount":100.0,"weight":10},"item":{"id":"2","name":"Name 2","descriptors":[{"type":"item.color","value":"Blue"},{"type":"item.capability.Plays Diablo Immortal","value":"true"},{"type":"item.weight","value":"675"},{"type":"item.storage.capacity","value":"128"}],"cost":100.0,"scoreExplanation":{"overallHardScore":0,"overallSoftScore":0,"overallScorePercentage":1.0,"overallScorePercentageWithRewards":1.0,"requirementsScorePercentage":1.0,"budgetScorePercentage":1.0,"brokenRequirements":[],"exceededRequirements":[],"metRequirements":[]}},"requirementsTotalWeight":10,"rejectedSoftRequirements":[]}],"items":[{"id":"2","name":"Name 2","descriptors":[{"type":"item.color","value":"Blue"},{"type":"item.capability.Plays Diablo Immortal","value":"true"},{"type":"item.weight","value":"675"},{"type":"item.storage.capacity","value":"128"}],"cost":100.0,"scoreExplanation":{"overallHardScore":0,"overallSoftScore":0,"overallScorePercentage":1.0,"overallScorePercentageWithRewards":1.0,"requirementsScorePercentage":1.0,"budgetScorePercentage":1.0,"brokenRequirements":[],"exceededRequirements":[],"metRequirements":[]}},{"id":"4","name":"Name 4","descriptors":[{"type":"item.color","value":"Red"},{"type":"item.capability.PLays Minecraft","value":"true"},{"type":"item.weight","value":"850"},{"type":"item.storage.capacity","value":"256"}],"cost":100.0,"scoreExplanation":{"overallHardScore":-10,"overallSoftScore":0,"overallScorePercentage":0.5,"overallScorePercentageWithRewards":0.5,"requirementsScorePercentage":0.0,"budgetScorePercentage":1.0,"brokenRequirements":[{"type":"item.color","scoringLogic":{"method":"Penalize","comparisonLogic":"NotEqual","weight":10,"constraintHardness":"hard","weightRelativePercentage":1.0},"values":["Blue"],"valueType":"string","penalty":10,"penaltyPercentage":0.5}],"exceededRequirements":[],"metRequirements":[]}},{"id":"1","name":"Name 1","descriptors":[{"type":"item.color","value":"Red"},{"type":"item.capability.Plays Roblox","value":"true"},{"type":"item.weight","value":"450"},{"type":"item.storage.capacity","value":"256"}],"cost":200.0,"scoreExplanation":{"overallHardScore":-20,"overallSoftScore":0,"overallScorePercentage":0.0,"overallScorePercentageWithRewards":0.0,"requirementsScorePercentage":0.0,"budgetScorePercentage":0.0,"brokenRequirements":[{"type":"item.color","scoringLogic":{"method":"Penalize","comparisonLogic":"NotEqual","weight":10,"constraintHardness":"hard","weightRelativePercentage":1.0},"values":["Blue"],"valueType":"string","penalty":10,"penaltyPercentage":0.5},{"type":"purchase.budget.amount","scoringLogic":{"method":"Penalize","comparisonLogic":"GreaterThan","weight":10,"constraintHardness":"hard"},"values":["100.0"],"penalty":10,"penaltyPercentage":0.5}],"exceededRequirements":[],"metRequirements":[]}},{"id":"3","name":"Name 3","descriptors":[{"type":"item.color","value":"Red"},{"type":"item.capability.Plays Roblox","value":"true"},{"type":"item.weight","value":"420"},{"type":"item.storage.capacity","value":"128"}],"cost":200.0,"scoreExplanation":{"overallHardScore":-20,"overallSoftScore":0,"overallScorePercentage":0.0,"overallScorePercentageWithRewards":0.0,"requirementsScorePercentage":0.0,"budgetScorePercentage":0.0,"brokenRequirements":[{"type":"item.color","scoringLogic":{"method":"Penalize","comparisonLogic":"NotEqual","weight":10,"constraintHardness":"hard","weightRelativePercentage":1.0},"values":["Blue"],"valueType":"string","penalty":10,"penaltyPercentage":0.5},{"type":"purchase.budget.amount","scoringLogic":{"method":"Penalize","comparisonLogic":"GreaterThan","weight":10,"constraintHardness":"hard"},"values":["100.0"],"penalty":10,"penaltyPercentage":0.5}],"exceededRequirements":[],"metRequirements":[]}}],"solutionSummary":"Explanation of score (0hard/0soft):\n Constraint match totals:\n Indictments:\n"}]
curl --location --request POST 'https://zylalabs.com/api/5745/smart+decision+engine+api/7475/optimize+allocation' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"itemAssignments": [
{
"id": "1",
"requirements": [
{
"type": "item.color",
"values": [
"Blue"
],
"valueType": "string",
"scoringLogic": {
"comparisonLogic": "NotEqual",
"method": "Penalize",
"weight": 10,
"constraintHardness": "hard"
}
}
],
"budget": {
"amount": 100,
"weight": 10
}
}
],
"items": [
{
"id": "1",
"name": "Name 1",
"cost": 200,
"descriptors": [
{
"type": "item.color",
"value": "Red"
},
{
"type": "item.capability.Plays Roblox",
"value": "true"
},
{
"type": "item.weight",
"value": "450"
},
{
"type": "item.storage.capacity",
"value": "256"
}
]
},
{
"id": "2",
"name": "Name 2",
"cost": 100,
"descriptors": [
{
"type": "item.color",
"value": "Blue"
},
{
"type": "item.capability.Plays Diablo Immortal",
"value": "true"
},
{
"type": "item.weight",
"value": "675"
},
{
"type": "item.storage.capacity",
"value": "128"
}
]
},
{
"id": "3",
"name": "Name 3",
"cost": 200,
"descriptors": [
{
"type": "item.color",
"value": "Red"
},
{
"type": "item.capability.Plays Roblox",
"value": "true"
},
{
"type": "item.weight",
"value": "420"
},
{
"type": "item.storage.capacity",
"value": "128"
}
]
},
{
"id": "4",
"name": "Name 4",
"cost": 100,
"descriptors": [
{
"type": "item.color",
"value": "Red"
},
{
"type": "item.capability.PLays Minecraft",
"value": "true"
},
{
"type": "item.weight",
"value": "850"
},
{
"type": "item.storage.capacity",
"value": "256"
}
]
}
]
}'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
The Smart Decision Engine API is designed to optimize decisions by mapping elements to constraints, balancing costs and results efficiently for budget and resource management.
The API evaluates elements based on specific requirements and custom constraints, allowing companies to address complex allocation and optimization problems effectively.
The API is applicable in various industries including logistics, finance, and e-commerce, providing robust solutions that adapt to different workflows.
The API includes advanced functionalities such as criteria weighting, penalties for constraint violations, and dynamic adjustments based on custom parameters.
By simplifying critical decisions and allowing developers to focus on innovation and strategic problem-solving, the API helps organizations save time and resources in their decision-making processes.
The Optimize Allocation endpoint returns a JSON array containing optimal item assignments, including details on requirements, budget, and scoring explanations for each item. This data helps users understand how decisions were made based on their constraints.
Key fields in the response include `itemAssignments`, which detail assigned items and their requirements, `budget`, which shows the allocated amount, and `scoreExplanation`, providing insights into the scoring metrics used for optimization.
The response data is structured as a JSON object with two main arrays: `itemAssignments` for the assigned items and `items` for the details of each item. Each assignment includes requirements, budget information, and scoring metrics.
Users can customize their requests by including parameters such as `elements`, which specify the items to be optimized, and `assignments`, which define how these items should be allocated based on user-defined constraints.
Users can analyze the `scoreExplanation` to understand the effectiveness of their allocations, identify any penalties for unmet requirements, and adjust their input parameters to improve future optimization results.
Typical use cases include optimizing resource allocation in logistics, managing budgets in finance, and enhancing inventory decisions in e-commerce, allowing businesses to maximize efficiency and minimize costs.
Data accuracy is maintained through rigorous validation of input parameters and constraints, ensuring that the optimization process reflects realistic scenarios and adheres to the specified requirements.
Users can expect patterns such as multiple `itemAssignments` for various items, each with associated requirements and penalties. The scoring metrics will typically reflect a balance between budget adherence and requirement fulfillment.
To obtain your API key, you first need to sign in to your account and subscribe to the API you want to use. Once subscribed, go to your Profile, open the Subscription section, and select the specific API. Your API key will be available there and can be used to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
If you don’t cancel before the 7th day, your free trial will end automatically and your subscription will switch to a paid plan under the same plan you originally subscribed to, meaning you will be charged and gain access to the API calls included in that plan.
The free trial ends when you reach 50 API requests or after 7 days, whichever comes first.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost, so you can test our APIs without any commitment.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund
Service Level:
100%
Response Time:
4,492ms
Service Level:
100%
Response Time:
1,396ms
Service Level:
100%
Response Time:
136ms
Service Level:
100%
Response Time:
1,130ms
Service Level:
100%
Response Time:
573ms
Service Level:
100%
Response Time:
1,777ms
Service Level:
100%
Response Time:
57ms
Service Level:
100%
Response Time:
147ms
Service Level:
100%
Response Time:
5,202ms
Service Level:
100%
Response Time:
600ms
Service Level:
100%
Response Time:
196ms
Service Level:
100%
Response Time:
20,002ms
Service Level:
100%
Response Time:
20,002ms
Service Level:
100%
Response Time:
16,754ms
Service Level:
100%
Response Time:
20,003ms
Service Level:
100%
Response Time:
68ms
Service Level:
100%
Response Time:
254ms
Service Level:
100%
Response Time:
20,003ms
Service Level:
44%
Response Time:
496ms
Service Level:
100%
Response Time:
802ms
