Quick Start
Send a server-side request with your subscription key and a minimal payload:
$headers = @{
"Ocp-Apim-Subscription-Key" = "<YOUR_SUBSCRIPTION_KEY>"
"Content-Type" = "application/json"
}
$body = @{ texts = @("The World is Beautiful") } | ConvertTo-Json -Depth 6
Invoke-RestMethod -Method POST -Uri "https://api.smsquared.ai/v1/predict" -Headers $headers -Body $body
Starter Scaffold
After the quick test works, use the Starter Scaffold guide to move into a valid editable payload skeleton without guessing the 38-slot vector order by hand.
- Keep the same runtime contract family
- Preserve all fixed positions for the 10 + 28 slots
- Edit values safely without moving array order
Authentication
- Use the
Ocp-Apim-Subscription-Keyheader with your API key - Keep the key server-side — never ship it to browser JavaScript
- Rotate the key immediately if you suspect exposure
- Contact support@smsquared.ai for key management assistance
Request and Response
Request Format
- Send the smallest payload that captures the decision context
- Use JSON format with proper Content-Type header
- Include required fields as specified in the API schema
Response Format
- Expect a decision label plus supporting metadata for downstream routing
- Use the returned result to decide whether to execute, defer, or escalate
- Parse the response JSON and handle all possible decision states
Error Codes
| Status Code | Meaning |
|---|---|
| 401 Unauthorized | Missing or invalid subscription key |
| 403 Forbidden | Access denied due to plan limits, quota restrictions, or policy violations |
| 422 Unprocessable Entity | Invalid request body or malformed JSON payload |
| 429 Too Many Requests | Rate limit exceeded — respect the Retry-After header |
Support and Resources
Implementation Support: For technical questions and integration assistance, contact support@smsquared.ai
Legal and Policy: For compliance, terms of service, and data handling policies, visit the Trust Center
Interactive Testing: Use the API Playground to test endpoints and explore the API interactively