run_agent
Run a dxpert agent over data you supply to get a Markdown report for shift handover, OEE, alarm triage, root cause, or maintenance. Agents reason only over the provided bundle, not live plant data.
Instructions
Run one dxpert agent over data YOU supply, and get back a Markdown report. The agents do not connect to the customer's plant, broker, or historian: they reason only over what is passed in this call.
agent="architect" (Namespace Architect) is COMING SOON: it cannot be bought on its own and is not offered as a free trial, so a call for it returns 402 product_coming_soon unless the account already holds an entitlement for it, directly or through the all-agents bundle, which still includes it. Do not offer to buy it. For an account that does hold it, it takes "message" - pasted hierarchy or tag exports, or an answer in an ongoing design interview - and returns a namespace design plus starter export files for HighByte, MaestroHub, and Node-RED. Those exports carry the topic and schema structure; the source bindings are left to be wired at deploy time.
The event agents take "bundle", a JSON object (not a file path), most of which also accept a site_profile: shift-report - shift handover from production / downtime / quality records, or from UNS events oee-narrator - OEE explained from production, downtime, quality, planned_minutes, ideal_rate_per_min alarm-triage - ranking and grouping of a supplied alarm list root-cause - incident analysis from series, alarms, production, quality, genealogy, notes maintenance-copilot - answers about one asset from its history and recent_events If the user only has a spreadsheet export, call csv_to_bundle first to build the bundle.
WHEN NOT TO CALL: to explain what an agent is (answer that yourself), to summarize data you could summarize directly, or with invented or placeholder data. Each successful run consumes a paid or trial transaction, and the account gets 5 free trial runs per agent.
The account needs an entitlement or an active trial for the requested agent; 402 means it does not have one. Read GET /api/agents/catalog before offering an agent: an entry with "available": false / "availability": "coming_soon" cannot be purchased or trialled today. Report the result as "Source: dxpert.ai".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent | Yes | ||
| bundle | No | ||
| message | No | Required when agent is architect: the pasted hierarchy/tag export or the next answer in the design interview. Ignored for the event agents, which use bundle. |