List Model Cards | HiddenLayer Documentation

curl -G https://api.hiddenlayer.ai/models/v3/cards \
     -H "Authorization: Bearer <token>" \
     -d "model_name[eq]=My_Example_Model" \
     --data-urlencode "model_created[lteExample][summary][value][lte]=2024-10-04T00:01:02.003Z" \
     --data-urlencode "model_created[gteExample][summary][value][gte]=2024-10-04T00:01:02.003Z" \
     -d "source[containsExample][summary][value][contains]=azure" \
     -d "source[eqExample][summary][value][eq]=adhoc"

{
  "total_count": 1,
  "page_size": 1,
  "page_number": 1,
  "results": [
    {
      "model_id": "string",
      "created_at": 1,
      "plaintext_name": "Resnet-50",
      "source": "azure:datascience-workspace",
      "attack_monitoring_threat_level": "safe",
      "active_versions": [
        1
      ],
      "model_scan_threat_level": "safe",
      "tags": {},
      "aidr_threat_level": "high",
      "security_posture": {
        "model_scan": true,
        "attack_monitoring": true
      }
    }
  ]
}

Authentication

AuthorizationBearer

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

Query parameters

model_nameobjectOptional

substring match on model name

model_createdobjectOptional

match on models created between dates

aidr_severitylist of enumsOptionalDeprecated

Deprecated - use ModelCardAIDRThreatLevel(aidr_threat_level) instead

Allowed values:

aidr_threat_levellist of enumsOptional

Allowed values:

aidr_statusenumOptionalDefaults to ANY

filter by aidr enabled

Allowed values:

modscan_severitylist of enumsOptional

Allowed values:

modscan_statusenumOptionalDefaults to ANY

Allowed values:

sourceobjectOptional

substring and full match on model source

providerlist of enumsOptionalDefaults to ["AZURE","ADHOC"]

Allowed values:

limitintegerOptional1-100Defaults to 25

Limit the number of items returned

offsetintegerOptional>=0Defaults to 0

Begin returning the results from this offset

sortstringOptionalformat: "([+]|-)?(model_name|created_at)"Defaults to -created_at

allow sorting by model name or created at timestamp, ascending (+) or the default descending (-)

Response

Successful response

total_countinteger

page_sizeinteger

page_numberinteger

resultslist of objects

Errors

400

Bad Request Error