Get scan results (Summaries) | HiddenLayer Documentation

curl -G https://api.hiddenlayer.ai/scan/v3/results \
     -H "Authorization: Bearer <token>" \
     --data-urlencode model_version_ids=00fb9505-b9ac-4703-91a7-9d4859315a4b,0278fa73-4b08-47ca-bc23-33bc244719be \
     --data-urlencode model_ids=00fb9505-b9ac-4703-91a7-9d4859315a4b,2df09dc6-a0eb-4f67-9fe9-139ac3b75d11 \
     --data-urlencode start_time=2025-05-27T00:00:00Z \
     --data-urlencode end_time=2025-05-27T23:59:59Z \
     -d severity=critical \
     --data-urlencode status=done,failed \
     --data-urlencode "request_source=Hybrid Upload" \
     --data-urlencode region=us-east-1,eu-west-1 \
     --data-urlencode provider=AWS_BEDROCK,AZURE_AI_FOUNDRY \
     -d scanner_version=1.0.0 \
     --data-urlencode "detection_category=Embedded Payloads" \
     -d "model_name[eq]=tensorflow12" \
     -d compliance_status=COMPLIANT \
     -d deep_scan=true

{
  "items": [
    {
      "version": "string",
      "scan_id": "string",
      "start_time": "2024-01-15T09:30:00Z",
      "status": "pending",
      "inventory": {
        "model_name": "keras-tf-2025-05-27",
        "requested_scan_location": "/files-to-scan",
        "model_id": "00000000-0000-0000-0000-000000000000",
        "model_version_id": "00000000-0000-0000-0000-000000000000",
        "model_version": "1.0.0",
        "model_source": "adhoc",
        "file_location": "https://huggingface.co/meta-llama/Llama-3.1-8B",
        "provider_details": {
          "provider": "AWS_BEDROCK",
          "provider_model_id": "anthropic.claude-3-5-sonnet-20241022-v2:0"
        },
        "asset_region": "string",
        "requesting_entity": "string",
        "request_source": "Hybrid Upload",
        "origin": "Hugging Face"
      },
      "summary": {
        "severity": "critical",
        "highest_severity": "critical",
        "detection_count": 1,
        "advisory_count": 1,
        "file_count": 1,
        "files_with_detections_count": 1,
        "detection_categories": [
          "string"
        ],
        "advisory_categories": [
          "string"
        ],
        "files_failed_to_scan": 1,
        "unknown_files": 1
      },
      "file_count": 1,
      "files_with_detections_count": 1,
      "detection_count": 1,
      "has_genealogy": true,
      "$schema_version": "string",
      "end_time": "2024-01-15T09:30:00Z",
      "compliance": {
        "status": "COMPLIANT",
        "evaluated_at": "2024-01-15T09:30:00Z",
        "rule_set_ids": [
          "string"
        ]
      },
      "severity": "critical",
      "detection_categories": [
        "string"
      ]
    }
  ],
  "total": 1.1,
  "limit": 50,
  "offset": 250
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

model_version_idslist of stringsOptional

Model Version IDs

model_idslist of stringsOptional

Model ID

start_timedatetimeOptional

Start Time

end_timedatetimeOptional

End Time

severityenumOptional

Severities

statuslist of stringsOptional

Statuses

request_sourcelist of enumsOptional

Filter by request source using a comma-separated list

Allowed values:

regionlist of stringsOptional

Filter by region of the discovered asset

providerlist of stringsOptional

Filter by model provider name

limitintegerOptional1-100Defaults to 25

offsetintegerOptional>=0Defaults to 0

allow sorting by model name, status, severity, scan start time, asset region, or model provider ascending (+) or the default descending (-)

latest_per_model_version_onlybooleanOptionalDefaults to false

only return latest result per model version

sourceobjectOptional

source of model related to scans

scanner_versionstringOptionalformat: "^(0|[1-9][0-9]*)[.](0|[1-9][0-9]*)[.](0|[1-9][0-9]*)"

filter by version of the scanner

detection_categorystringOptional

filter by a single detection category

model_nameobjectOptional

filter by the model name

compliance_statuslist of enumsOptional

A comma separated list of rule set evaluation statuses to include

Allowed values:

deep_scanbooleanOptional

When true, returns only scans that with files. When false, returns only scans without files. When not provided, returns all scans.

Response

Successful response

itemslist of objects

List of items. If no matching items are found, then [] will be returned.

totaldouble>=0

Total number of items available based on the query criteria.

limitinteger1-100Defaults to 25

Maximum number of items to return

offsetinteger>=0Defaults to 0

Begin returning the results from this offset

Errors

400

Bad Request Error

404

Not Found Error