> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create a monitor > Creates a monitor (custom observability dashboard) in the workspace. Set `project_id` to scope the monitor to a project; omit it to create a workspace-wide monitor, which requires admin access. ## OpenAPI ````yaml post /v2/monitors openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Hub description: Hub items are reusable templates available to a workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Monitors description: >- Monitors are custom observability dashboards for traces, runtime metrics, and logs. Each monitor holds widgets that chart one telemetry query. List the metrics, operations, and dimensions available to your workspace with `GET /v3/telemetry/capabilities`, or start from a preset with `GET /v2/monitors/presets`. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspaces description: >- A workspace is the tenant. Create is called from a user session during onboarding; Get, List, and Update are the public management surface. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Telemetry description: >- Unified query envelope for traces, metrics, and logs. One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. - description: Beta. Run typed classification questions against a classify model. name: Classify - description: Search Gateway with managed credits or BYOK. name: Web Search - description: Beta. Run classification decisions with the classify contract. name: Decisions - name: Users description: >- Workspace user administration. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/monitors: post: tags: - Monitors summary: Create a monitor description: >- Creates a monitor (custom observability dashboard) in the workspace. Set `project_id` to scope the monitor to a project; omit it to create a workspace-wide monitor, which requires admin access. operationId: MonitorCreate requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMonitorRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateMonitorResponse' x-code-samples: - lang: TypeScript source: > import { Orq } from '@orq-ai/node'; const orq = new Orq({ apiKey: process.env.ORQ_API_KEY }); await orq.monitors.create({ displayName: 'LLM cost', projectId: 'proj_01J81V5RZPVTDHXBV6M2YVJHRB', defaultRange: '7d', widgets: [{ widgetId: 'cost', type: 'timeseries', title: 'Cost by model', queries: [{ metric: 'genai.cost', groupBy: ['model'] }], layout: { x: 0, y: 0, w: 12, h: 4 } }] }); components: schemas: CreateMonitorRequest: required: - display_name type: object properties: display_name: type: string description: Workspace-unique display name. description: type: string description: Short human-readable summary of what the monitor tracks. project_id: type: string description: |- Project that should own the monitor. Omit to create a workspace-wide monitor (requires admin access). widgets: type: array items: $ref: '#/components/schemas/MonitorWidget' description: >- Widgets to render on the monitor. Empty creates a valid blank monitor. default_range: type: string description: Default relative time range applied when the monitor opens. preset_key: enum: - genai-overview - cost-analysis - latency - quality - widget-spans - widget-latency - widget-total-llm-cost - widget-token-count - widget-scores - widget-time-to-first-token - widget-tool-executions - widget-tool-error-rate - widget-tool-duration-p50 type: string description: >- Known preset used to create the monitor. Empty when built from scratch. CreateMonitorResponse: required: - monitor type: object properties: monitor: allOf: - $ref: '#/components/schemas/Monitor' description: Newly created monitor. MonitorWidget: required: - widget_id - type - title - queries - layout type: object properties: widget_id: type: string description: |- Widget identifier, unique within the monitor. Provide your own or leave empty to have the server assign one. type: enum: - timeseries - toplist - table - bignumber type: string description: Widget rendering type. title: type: string description: Title shown in the widget header. queries: type: array items: $ref: '#/components/schemas/MonitorWidgetQuery' description: |- The one query feeding the widget. It maps onto QueryTelemetry; the viewer's time range, time zone, and the query mode derived from the widget type are supplied at render time. display: description: >- Display options such as visualization style and unit. `null` when none are saved. anyOf: - allOf: - $ref: '#/components/schemas/MonitorWidgetDisplay' - type: 'null' layout: allOf: - $ref: '#/components/schemas/MonitorWidgetLayout' description: Position and size on the monitor grid. Monitor: required: - monitor_id - display_name - description - project_id - widgets - preset_key - created_at - updated_at - created_by_id - updated_by_id type: object properties: monitor_id: type: string description: |- Unique monitor identifier assigned by ORQ, for example `monitor_01H...`. Use this value in retrieve, update, and delete requests. display_name: type: string description: Workspace-unique display name. description: type: string description: Short human-readable summary of what the monitor tracks. project_id: type: string description: >- Project that owns the monitor. Empty for workspace-wide monitors (admin-managed). Immutable after creation. widgets: type: array items: $ref: '#/components/schemas/MonitorWidget' description: |- Widgets rendered on the monitor, each carrying its own query and layout position. default_range: enum: - 5m - 15m - 30m - 1h - 6h - 12h - 1d - 7d - 14d - 30d - 60d - 90d type: string description: Default relative time range applied when the monitor opens. preset_key: type: string description: Preset this monitor was created from. Empty when built from scratch. created_at: type: string description: Time when the monitor was created. format: date-time updated_at: type: string description: Time when the monitor was last updated. format: date-time created_by_id: type: string description: User ID that created the monitor. updated_by_id: type: string description: User ID that last updated the monitor. MonitorWidgetQuery: required: - metric type: object properties: source: $ref: '#/components/schemas/MonitorTelemetrySource' description: Source queried through QueryTelemetry. metric: type: string description: |- Source-owned metric identifier. Static `genai.*` trace metrics are validated when saved; runtime metrics, logs, and raw trace aggregates are validated by the caller-scoped telemetry capability/query service. operation: type: string description: >- Source-owned aggregation operation advertised by telemetry capabilities. group_by: type: array items: type: string description: |- Reporting dimensions to break down by. Valid dimensions depend on the metric; validated when the monitor is saved. filters: type: array items: $ref: '#/components/schemas/MonitorFilter' description: Reporting filters combined with AND. grain: enum: - auto - minute - hour - day type: string description: Requested bucket grain for timeseries widgets. limit: type: integer description: >- Row cap. Zero uses the reporting default. For toplist widgets this is the top-N group count. format: int32 MonitorWidgetDisplay: type: object properties: visualization: enum: - lines - bars - area type: string description: Chart style for timeseries widgets. unit: enum: - count - cost - duration - percent - bytes type: string description: Unit used for axis and value formatting. sort: enum: - desc - asc type: string description: Value ordering for toplist widgets. show_overall: type: boolean description: |- When true, toplist widgets also show the overall total across all groups for the window. target: type: number description: Optional threshold line rendered on timeseries widgets. format: double decimals: type: integer description: Decimal places used when formatting values. format: int32 show_others: type: boolean description: |- When true, toplist widgets show the combined value of groups outside the configured limit. show_percentages: type: boolean description: |- When true, toplist widget values are shown as a percentage of the overall total. MonitorWidgetLayout: required: - x - 'y' - w - h type: object properties: x: type: integer description: Column offset in grid units. format: int32 'y': type: integer description: Row offset in grid units. format: int32 w: type: integer description: Width in grid units. format: int32 h: type: integer description: Height in grid units. format: int32 MonitorTelemetrySource: type: string enum: - MONITOR_TELEMETRY_SOURCE_UNSPECIFIED - MONITOR_TELEMETRY_SOURCE_TRACES - MONITOR_TELEMETRY_SOURCE_METRICS - MONITOR_TELEMETRY_SOURCE_LOGS MonitorFilter: required: - field - op - values type: object properties: field: type: string description: |- Reporting dimension to filter on. Valid fields depend on the metric; validated when the monitor is saved. op: enum: - eq - neq - in - not_in - gt - gte - lt - lte - between - contains - exists - not_exists type: string description: >- Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values. values: type: array items: type: string description: Values compared against the selected field. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.