---
title: "Get scan result summary"
method: GET
path: "/scan/v3/results/{scan_id}/summary"
tags: ["Model Scanner SaaS", "Model Scanner Hybrid"]
---

# Get scan result summary

`GET /scan/v3/results/{scan_id}/summary`

Returns aggregated summary information for a scan without file-level results.

## Response `200`

Successful response

- ScanReportSummaryResponseV3 — A scan report summary containing header and aggregated statistics without file-level results.
  - `has_genealogy` boolean — if there is model geneaology info available
  - `version` string, required — scanner version
  - `$schema_version` string — version of the scan report schema format
  - `scan_id` string, required — unique identifier for the scan
  - `start_time` string, date-time, required — time the scan started
  - `end_time` string, date-time — time the scan ended
  - `status` 'pending' | 'running' | 'done' | 'failed' | 'canceled', required — status of the scan
  - `inventory` ScanModelInventoryComboV3, required
    - `model_name` string, required — name of the model
    - `model_version` string — version of the model
    - `model_source` string — source (provider) info
    - `requested_scan_location` string, required — Location to be scanned
    - `file_location` string — URL or path to the model files, if available
    - `provider_details` ProviderDetails
      - `provider` 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AZURE_AI_FOUNDRY' | 'AZURE_ML' | 'DATABRICKS', required
      - `provider_model_id` string, required — The provider's unique identifier for the model. Examples: - AWS Bedrock: "anthropic.claude-3-5-sonnet-20241022-v2:0" - Azure AI Foundry: "Claude-3-5-Sonnet"
      - `model_arn` string — Optional full ARN or resource identifier for the model. Used for provisioned models, custom deployments, or cross-account access.
      - `country` string — Optional country code (ISO 3166-1 alpha-2) for the location where the model provider is primarily based.
    - `asset_region` string — Region of discovered asset
    - `asset_id` string, uuid — Identifier of discovered asset
    - `requesting_entity` string — Entity that requested the scan
    - `request_source` 'Hybrid Upload' | 'API Upload' | 'Integration' | 'UI Upload' | 'AI Asset Discovery' — Identifies the system that requested the scan
    - `origin` string — Specifies the platform or service where the model originated before being scanned
    - `model_id` string, required — Unique identifier for the model
    - `model_version_id` string, required — unique identifier for the model version
  - `intelligence` ModelIntelligence — Intelligence metadata about a model including origin, licensing, and usage policies
    - `geographic_footprint` string[] — List of countries where the model originated
    - `country_of_origin` string — ISO 3166-1 alpha-2 country code of the model's primary origin
    - `contributor_trust_level` string — Trust level of the model contributor
    - `licenses` ModelLicense[] — List of licenses associated with the model
      - `name` string, required — Name of the license
      - `sha256` string, required — SHA256 hash of the license file
    - `usage_policies` ModelUsagePolicy[] — List of usage policies associated with the model
      - `name` string, required — Name of the usage policy
      - `sha256` string, required — SHA256 hash of the policy document
  - `summary` object, required
    - `severity` 'critical' | 'high' | 'medium' | 'low' | 'unknown' | 'safe' — The highest severity of any detections on the scan, including "safe". Use `.summary.highest_severity` instead.
    - `highest_severity` 'critical' | 'high' | 'medium' | 'low' | 'none' | 'unknown' — The highest severity of any detections on the scan.
    - `detection_count` integer — total number of detections found
    - `advisory_count` integer — total number of advisories found
    - `file_count` integer — total number of files scanned
    - `files_with_detections_count` integer — number of files that contain detections
    - `detection_categories` string[] — list of unique detection categories found
    - `advisory_categories` string[] — list of unique advisory categories found
    - `files_failed_to_scan` integer — number of files that failed during scanning
    - `unknown_files` integer — number of files with unknown file type
  - `compliance` object
    - `status` 'COMPLIANT' | 'NONCOMPLIANT'
    - `evaluated_at` string, date-time — The datetime when the rule set was evaluated against the scan result
    - `rule_set_ids` string[] — A list of non-default rule sets that were used when evaluating the scan result
  - `scan_error` string[] — Error messages returned by the scanner
  - `referenced_models` string[] — URLs of model artifact files referenced in a NIM container's model_manifest.yaml. Only present for NIM container scans.

## Other responses

- `400` — The request failed due to a client error, with one or more of the following possible causes: 1. The request required a tenant_id field, which was missing. 2. The request was malformed syntactically or semantically.
- `401` — Authentication Error
- `403` — Forbidden Error
- `404` — The specified resource was not found.

---

[API](https://skmtc.net/hiddenlayerai/apis/hiddenlayer-audit-api.md) · [All operations](https://skmtc.net/hiddenlayerai/apis/hiddenlayer-audit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hiddenlayerai/hiddenlayer-audit-api/versions/efca861e915b/schema)