Skip to content
POST/api/v1/verticals/{id}/scan

Run a vertical attack pack scan

Runs a consolidated industry vertical attack pack against a target model under the caller's org scope, persisting to the org-scoped security_scans store. The path id accepts a canonical vertical id or a legacy alias.

Authentication

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

Parameters

id in pathrequired

Vertical pack id (canonical or legacy alias)

string

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "model": "gpt-4o",
  "prompt": "string",
  "strategies": [
    "string"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "model": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "example": "gpt-4o"
        },
        "prompt": {
          "type": "string",
          "minLength": 1
        },
        "strategies": {
          "maxItems": 32,
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "projectId",
        "model",
        "prompt"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Vertical scan completed

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/verticals/{id}/scan \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "model": "gpt-4o", "prompt": "string", "strategies": [ "string" ] }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/verticals/{id}/scan",
  body: {
    "projectId": "00000000-0000-0000-0000-000000000000",
    "model": "gpt-4o",
    "prompt": "string",
    "strategies": [
      "string"
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/verticals/{id}/scan",
    body={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "model": "gpt-4o",
    "prompt": "string",
    "strategies": [
        "string"
    ]
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","model":"gpt-4o","prompt":"string","strategies":["string"]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/verticals/{id}/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)
}

Other Security endpoints