v1

latestOpenAPI 3.0.02026-07-13211133.5 KB

Public Scan

Security Assistant

This API forwards the incoming question and vulnerability context to an external AI model assistant and streams back the AI's response in real-time (text/event-stream).

post/api/v2/ai/assistant

Query parameters

orgstring required

Organization ID

Request body

codestring

A code snippet representing the vulnerable logic or affected lines.

cwe_idstring

CWE identifier, if applicable.

cwe_namestring

Optional name or title of the CWE.

linestring

Line number(s) where the issue appears.

filestring

Name or path of the file containing the snippet.

promptstring

A question to the Security Assistant

statusstring

TRUE POSITIVE, FALSE POSITIVE or UNVERIFIED

Reasonstring

Reason of how this is identified as vulnerability from the scanner

Remedationstring

User parameters in the Query string

Example request

{
  "code": "try {\n  const user = db.getUserById(req.query.id);\n  res.send(user);\n} catch (err) {\n  res.status(500).send(\"Error\");\n}\n",
  "cwe_id": "CWE-79",
  "cwe_name": "Cross-Site Scripting",
  "line": "105",
  "file": "userController.js",
  "prompt": "How to fix this?",
  "status": "UNVERIFIED",
  "Reason": "SQL Injection in the code",
  "Remedation": "User parameters in the Query string"
}

Response

Successful classification result from the AI model in streaming format.

string required