Analysis request
Send one file to be analyzed in the Hyper Sandbox. It finishes in 0.27 s on average, and the result comes back directly in the response. If processing takes longer, the API returns 202 with a filescan_id — fetch the result with Get result. [To be updated once sync/async is finalized]
Request
| Name | In | Description |
|---|---|---|
| Authorization Required | header | Bearer <evaluation key> |
| file Required | form-data | One file to analyze, up to [N] MB |
| Idempotency-Key | header | Resend with the same value to get the same result without being counted twice |
Response fields
| data.verdict | malicious · suspicious · clean · unknown |
| data.risk | Risk score 0–10 (same scale as ZX HUB) |
| data.file.sha256 | File hash |
| data.mitre[] | ATT&CK technique IDs |
| data.evidence[] | Risk signals (risk · description · location) |
| quota | day_left · total_left · expires_at |
Errors
| 401 | invalid_key | Missing key, or a key stopped by reissue |
| 403 | evaluation_ended | 30-day evaluation ended or 2,000 requests used up — request an extension in My API |
| 413 | file_too_large | File too large |
| 415 | unsupported_type | Unsupported file type |
| 429 | rate_limited · daily_limit | Per-minute or concurrency limit, or more than 50 requests in a day (see Retry-After) |
| 503 | engine_busy | Temporarily unavailable — not counted |
Disarm with the same key
POST /v1/disarmSend a file the same way to get back a file with active elements such as macros, scripts and external links removed. Requests are counted together with analysis, and the response includes disarmed_url (download, valid for [N hours]), removed[] (removed elements and their locations) and preserved (whether body text and formatting were preserved).