Skip to content
POST/api/v1/security/model-scan

Scan a model by URL / HuggingFace repo

Fetches a model artifact from a public source (HuggingFace repo, URL, or S3 https URL), SSRF-guarded, scans it for unsafe deserialization/backdoors, records a model_scans row, and returns the verdict inline (synchronous).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "source": "huggingface",
  "sourceRef": "<HF repo:filename / blob path, or an http>",
  "filename": "string",
  "maxBytes": 0
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "projectId",
        "source",
        "sourceRef"
      ],
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid"
        },
        "source": {
          "type": "string",
          "enum": [
            "huggingface",
            "url",
            "s3"
          ]
        },
        "sourceRef": {
          "type": "string",
          "maxLength": 2000,
          "description": "HF repo:filename / blob path, or an https URL."
        },
        "filename": {
          "type": "string",
          "maxLength": 500
        },
        "maxBytes": {
          "type": "integer",
          "description": "Size cap; capped server-side at 2 GB."
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

200OK.
201Scan recorded (scanId + result).
400(no description)
401(no description)
403Refusing to scan a private/internal URL (SSRF_BLOCKED).
409Conflict — CONFLICT.
429(no description)
500Internal Server Error — DB_ERROR.
502Bad Gateway — FETCH_FAILED.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/security/model-scan \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "source": "huggingface", "sourceRef": "<HF repo:filename / blob path, or an http>", "filename": "string", "maxBytes": 0 }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/security/model-scan", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "projectId": "00000000-0000-0000-0000-000000000000",
    "source": "huggingface",
    "sourceRef": "<HF repo:filename / blob path, or an http>",
    "filename": "string",
    "maxBytes": 0
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/security/model-scan",
    headers=headers,
    json={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "source": "huggingface",
    "sourceRef": "<HF repo:filename / blob path, or an http>",
    "filename": "string",
    "maxBytes": 0
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","source":"huggingface","sourceRef":"<HF repo:filename / blob path, or an http>","filename":"string","maxBytes":0}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/security/model-scan", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403409429500502

Other Security endpoints