Agent Insight Monitors
create
Create an Agent Insights monitor for an agent.
Query parameters
api-version
string
required
The API version to use for this operation.
Request Body
agent_name
string
required
The agent this monitor should analyze.
enabled
boolean
Whether scheduled insight generation should be armed. Defaults to false.
run_interval_hours
number
Interval between scheduled insight runs, in hours. Defaults to 6.
model_deployment_name
string
required
The model deployment to use for analyzing traces. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'.
priorities
AgentInsightPriorities
Monitor analysis priorities.
categories
string[]
required
Up to 20 distinct normalized category identifiers (128 UTF-8 bytes each). Empty uses defaults.
instructions
string | null
Analysis guidance, up to 2,000 UTF-8 bytes after trimming. Null or blank removes guidance.
Responses
The request has succeeded and a new resource has been created as a result.
Headers
Location
string
required
URL of the created monitor.
Body
id
string
required
The monitor identifier.
agent_name
string
required
The agent this monitor analyzes. There can be only one monitor per agent.
enabled
boolean
required
Whether scheduled insight generation is armed for the monitor.
run_interval_hours
number
required
Interval between scheduled insight runs, in hours.
model_deployment_name
string
required
The model deployment to use for analyzing traces. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'.
estimated_cost
AgentInsightEstimatedCost
Estimated Agent Insights cost.
amount
number
required
Estimated cost amount.
currency
enum
required
Currency for the estimated cost amount. Agent Insights estimates are reported in US dollars.
suspension
AgentInsightSuspension | null
required
Why the system suspended scheduled generation. Null when the monitor is not suspended.
code
string
required
Stable, machine-readable suspension category.
message
string
required
Human-readable description of the suspension.
details
object
Additional reason-specific suspension details.
agent_summary
AgentInsightSummary
Service-generated agent summary.
markdown
string
required
Summary in Markdown.
priorities
AgentInsightPrioritiesRead
Monitor analysis priorities returned by the service.
categories
string[]
required
Up to 20 distinct normalized category identifiers. Can include legacy names containing commas. Empty uses defaults.
instructions
string
Analysis guidance. Omitted when unavailable.
Request
POST /agent_insight_monitors HTTP/1.1
Response
Status: 201
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json