---
title: "Security Assistant"
method: POST
path: "/api/v2/ai/assistant"
tags: ["Public Scan"]
---

# Security Assistant

`POST /api/v2/ai/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).

## Query parameters

- `org` string, required

## Request body

- object
  - `code` string — A code snippet representing the vulnerable logic or affected lines.
  - `cwe_id` string — CWE identifier, if applicable.
  - `cwe_name` string — Optional name or title of the CWE.
  - `line` string — Line number(s) where the issue appears.
  - `file` string — Name or path of the file containing the snippet.
  - `prompt` string — A question to the Security Assistant
  - `status` string — TRUE POSITIVE, FALSE POSITIVE or UNVERIFIED
  - `Reason` string — Reason of how this is identified as vulnerability from the scanner
  - `Remedation` string — User parameters in the Query string

## Response `200`

Successful classification result from the AI model in streaming format.

- string

## Other responses

- `400` — Invalid request format
- `500` — Internal server error or AI model not configured
- `502` — Failed to reach external AI model

---

[API](https://skmtc.net/aquilax-ai/apis/aquilax-ai-api-docs.md) · [All operations](https://skmtc.net/aquilax-ai/apis/aquilax-ai-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aquilax-ai/aquilax-ai-api-docs/versions/9b4f595ad674/schema)