AI API

Use the AI service API to manage and control chat functionality.

---

ChatAI

AI chat functionality for security-related questions and analysis.

Endpoint

POST: /ai/chat-ai/

Parameters

Name	Type	In	Required	Description
question	string	body	yes	Question to send to AI (minimum length 1 character)
chat_history	array	body	no	Array of chat history
chat_history[].role	int	body	no	Chat role (1=User message, 2=AI assistant response, 3=System message)
chat_history[].content	string	body	no	Chat content

Code sample

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{
      "question": "What are the security risks?",
      "chat_history": [
        {
          "role": 1,
          "content": "Please tell me about the previous vulnerability scan results"
        },
        {
          "role": 2, 
          "content": "The previous scan detected 3 medium-severity vulnerabilities"
        }
      ]
    }'\
    'https://{your-site}/api/v1/ai/chat-ai/'

Response

Status: 200 OK

{
  "data": {
    "answer": "Based on the detected security risks, SQL injection vulnerability is the most critical issue. We recommend implementing parameterized queries to prevent unauthorized database access."
  }
}

---

GenerateReport

Generate AI-powered security reports based on findings data.

Endpoint

POST: /ai/generate-report/

Parameters

Name	Type	In	Required	Description
prompt	string	body	yes	Prompt for report generation (minimum length 1 character)
project_id	number	body	yes	Project ID (value >= 1)
name	string	body	yes	Report name (minimum length 1 character)

Code sample

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{
      "prompt": "Generate a comprehensive security report for this month including vulnerability analysis and recommendations",
      "project_id": 1001,
      "name": "Monthly Security Report - January 2023"
    }' \
    'https://{your-site}/api/v1/ai/generate-report/'

Response

Status: 200 OK

{
  "data": {
    "report_id": 1001,
    "status": "IN_PROGRESS"
  }
}