AI Features
AI-powered request generation, response analysis, project import, documentation generation, and response docs with source-code awareness.
AI Prompt Bar
Toggle the AI prompt bar inside any request editor to generate or modify requests using natural language. The AI will set the method, URL, headers, body, and params based on your description.
Generate a Request
In the request editor, open the AI prompt bar and describe what you need:
"GET all users with pagination, sorted by created_at desc"
"POST create a new product with name, price, category, and image upload"The AI fills in the method, URL, headers, and body template. You can then edit and refine before sending.
Analyze Response
After sending a request, click AI Analyze to get an AI-generated summary of the response — insights about the data structure, potential issues, and suggestions.
Generate a Cluster
Create a full API collection from scratch:
- Right-click a nexus → AI Generate Cluster
- Enter a description (e.g., “REST API for e-commerce with products, orders, users, and payments”)
- Optionally provide a base URL
- Press Cmd+Enter to generate
The AI creates folders, requests, headers, query params, and body templates for the entire API.
Fill Existing Cluster
Right-click an existing cluster → AI Fill Cluster to add more requests. The AI is aware of existing requests and avoids duplicates.
Import from Project
The most powerful AI feature — generate an API cluster from your actual source code:
- Right-click a nexus → Import from Project
- VortexHQ scans your local dev projects and shows a searchable picker (or browse for a custom folder)
- Select the project — VortexHQ reads its route files
- Choose to create a new cluster or merge into an existing one (with deduplication)
- Optionally set a base URL
- Processing runs in the background — a progress badge appears in the bottom-right corner with a popup showing job details, elapsed time, and completion count
Routes are processed in batches of 15, with 3 running in parallel for speed.
AI Documentation Generation
In the Cluster Overview, the AI can auto-generate:
| Feature | How to Use |
|---|---|
| Cluster Description | Click the AI Generate button in the Description section. AI writes a comprehensive HTML description based on the cluster's structure. |
| Documentation Notes | Click the AI Generate button in the Documentation > Notes section. |
| Response Docs (single) | Right-click an endpoint in the Endpoint Reference → Generate Response Docs. AI analyzes the request and generates field documentation with type badges (required, optional, nullable, enum, cast), a success response example, and an error response example. |
| Response Docs (bulk) | Click Sync All Response Docs to generate docs for every endpoint sequentially with a progress bar and cancel button. |
Connected Repository
When a cluster has a connected repository (local project folder), the AI response doc generation becomes source-code aware. VortexHQ uses IPC to call findEndpointSource() which analyzes your controller methods, validation rules, Eloquent model casts, and relationships to produce more accurate field documentation with badges like:
- required (red), optional (gray), nullable (amber)
- enum values (purple), cast type (cyan), polymorphic (pink)
- default value (green), validation rules (monospace)
PDF Export
Export your cluster's full endpoint documentation as a styled PDF:
- Open the Cluster Overview → Documentation section
- Click Export Docs as PDF
- A system save dialog appears — choose the destination
The PDF includes: title page, notes, folder sections, each endpoint with parameters, headers, body, field documentation (with badges), and success/error response examples — all formatted with print-optimized styles.