Coach Agent API
Invoke the VisualQ Coach AI from CI, IDE agents, or internal automation.
Coach Agent API
POST /api/coach/v1/agent runs the Coach AI without the in-app chat UI. It is intended for internal automation such as CI jobs or IDE agents.
Authentication uses an API key in the Authorization header:
Authorization: Bearer $COACH_AGENT_API_KEYServer configuration accepts either raw keys or sha256:<hash> values in COACH_AGENT_API_KEYS.
Request
{
"orgId": "org_123",
"projectId": "project_123",
"message": "Analyze the latest failed visual run and summarize the likely causes.",
"feature": "vrt",
"action": "analysis",
"context": {
"lastRunResults": true
}
}orgId and message are required. projectId, userId, feature, action, and context are optional. Pass userId when you want usage and audit trails attributed to a specific user.
Response
{
"reply": "The most likely cause is dynamic content in the hero carousel...",
"feature": "vrt",
"action": "analysis",
"model": "anthropic/claude-sonnet-4",
"key": "a1b2c3d4"
}| Field | Description |
|---|---|
reply | Coach response text |
feature | Resolved feature key (e.g. vrt, frt) |
action | Resolved action key |
model | LLM model used, or null if no generation ran |
key | Truncated hash of the API key used (for audit logs) |
The API returns JSON only. UI tools such as navigate are not executed from this endpoint.