Base URLs
Staging uses separate API keys from production. Contact the SNH AI Team to obtain staging credentials.
API Keys
API keys are issued per organization, per environment. See Account Setup to obtain your credentials.
For authentication details, see Authentication.
Usage Guidelines
- Timeouts: Set your HTTP client timeout to at least 120 seconds for evaluation requests.
- Payload size: XML payloads with many cases/charges may result in longer response times.
Response Times
Response times vary based on record complexity (number of cases and offenses) and current system load.
Timeout and Error Handling
- Set your HTTP client timeout to 120 seconds.
- If the API does not respond within the timeout, retry once after 5 seconds.
- If the retry also fails, route the record to your manual review queue.
- Check
/healthbefore retrying to confirm service availability.
Verifying Your Integration
1
Health Check
Call
/health and verify a 200 response. See Health endpoint.2
Get Token
Exchange your API key for a JWT token via
/auth/token. See Authentication.3
Evaluate a Record
Submit a single record via
/evaluate and verify the response structure. See Quickstart.