CyberStrikeAI/docs/en-US/api-recipes.md

API Recipes

中文

Common API workflows for scripts and plugins. Use /api-docs and /api/openapi/spec for complete schemas.

Recipe 1: Login and Validate

curl -k https://127.0.0.1:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"password":"<password>"}'

Use:

Authorization: Bearer <token>

Validate:

curl -k https://127.0.0.1:8080/api/auth/validate \
  -H "Authorization: Bearer <token>"

Recipe 2: Create Conversation and Send Message

Simplest path: call Agent without pre-creating an empty conversation.

curl -k https://127.0.0.1:8080/api/eino-agent \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"message":"Run authorized basic read-only recon against 127.0.0.1"}'

If you need an empty conversation first:

curl -k https://127.0.0.1:8080/api/conversations \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"title":"Web Test"}'

Then pass conversationId to the Agent request.

Recipe 3: Stream Agent Output

curl -k -N https://127.0.0.1:8080/api/eino-agent/stream \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"message":"Summarize current project facts and propose read-only next steps"}'

Notes:

• -N disables curl buffering.
• reverse proxy buffering must also be disabled.
• wait for done.

Recipe 4: Multi-Agent

curl -k -N https://127.0.0.1:8080/api/multi-agent/stream \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "message":"Run a staged authorized Web security test; plan first, execute read-only steps",
    "orchestration":"plan_execute"
  }'

Options:

• deep
• plan_execute
• supervisor

Recipe 5: Upload Attachment

curl -k https://127.0.0.1:8080/api/chat-uploads \
  -H "Authorization: Bearer <token>" \
  -F "file=@./request.txt"

Upload large files and reference them in messages instead of pasting raw content.

Recipe 6: Create Vulnerability

curl -k https://127.0.0.1:8080/api/vulnerabilities \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "title":"Example SQL Injection",
    "severity":"high",
    "target":"https://example.com/item?id=1",
    "description":"Parameter id has verified SQL injection",
    "evidence":"read-only validation output...",
    "remediation":"Use parameterized queries"
  }'

Check OpenAPI for exact fields.

Recipe 7: Search Knowledge Base

curl -k https://127.0.0.1:8080/api/knowledge/search \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "query":"How to infer SQL injection column count",
    "riskType":"SQL Injection",
    "topK":5,
    "threshold":0.4
  }'

If empty, check categories first.

Recipe 8: External MCP Status

curl -k https://127.0.0.1:8080/api/external-mcp/stats \
  -H "Authorization: Bearer <token>"

If service is running but Agent cannot find tools, check role constraints and tool_search.

Recipe 9: Tool Schema

curl -k https://127.0.0.1:8080/api/config/tools/nmap/schema \
  -H "Authorization: Bearer <token>"

Scripts should build args from schema rather than guessing field names.

Recipe 10: Export Audit Logs

curl -k "https://127.0.0.1:8080/api/audit/logs/export" \
  -H "Authorization: Bearer <token>" \
  -o audit.csv

Exported logs may contain sensitive operational data. Store encrypted.