API Quickstart

Prerequisites

Before you begin, make sure you have the following:

• A Pro plan or above: API access is available on Pro, Business, and Enterprise tiers. See Pricing for plan details.
• An API key with upload and files.read scopes.

Navigate to the API Keys page in your portal. Click Create Key, give it a descriptive name, and select the upload and files.read scopes.

Uploading a file is a three-step process: compute the file hash, request an upload URL, then upload the file directly. Use your actual API base URL from the portal in place of the example URL below.

sha256sum myfile.exe

curl -X POST https://api.example.com/v1/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "myfile.exe",
    "contentType": "application/octet-stream",
    "sha256": "HASH"
  }'

curl -X PUT "UPLOAD_URL" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @myfile.exe

curl -X POST https://api.example.com/v1/upload/complete \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sha256": "HASH"}'

Once the analysis completes (typically within 60 seconds), retrieve your results using the files endpoint.

curl https://api.example.com/v1/files \
  -H "Authorization: Bearer YOUR_API_KEY"

The response includes the trust score, verdict, detection results, vendor information, and all other analysis findings for each file in your account.

Automate with Webhooks

Instead of polling for results, configure a webhook to receive analysis results as soon as they complete. Navigate to Settings → Integrations in your portal and add a webhook URL. The platform will send a POST request with the full analysis payload to your endpoint each time a file is analyzed.

Webhooks are ideal for CI/CD pipelines, automated security gates, and integrating analysis results into your existing tooling.

Rate Limits

API requests are subject to rate limits based on your plan tier. If you exceed the limit, the API returns a 429 Too Many Requests response. Each response includes rate limit headers so you can track your remaining quota. See Pricing for per-plan analysis limits.

Full API Reference

This guide covers the essentials. For complete endpoint documentation including request and response schemas, error codes, and advanced query parameters, visit the full API reference in your portal.