> ## Documentation Index > Fetch the complete documentation index at: https://docs.bigdata.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a monitor > Create a monitor with an intent and schedule. Optionally customize its name, search, extraction rules, output fields, and entity watchlist. Set `status` to `inactive` while you test the monitor, then change it to `active` when it is ready to run continuously. ## OpenAPI ````yaml /api-rest/openapi/openapi_search_monitoring.json post /v1/search-monitoring/monitors openapi: 3.1.0 info: title: Monitors API description: >- Coming soon. Run a saved Bigdata Search on a schedule and receive structured events from new content. Test a monitor against recent historical data before turning it on. version: 1.0.0 servers: - url: https://api.bigdata.com description: Production server security: - API Key Authentication: [] tags: - name: Monitors description: Coming soon. Create, test, activate, and review monitors. paths: /v1/search-monitoring/monitors: post: tags: - Monitors summary: Create a monitor description: >- Create a monitor with an intent and schedule. Optionally customize its name, search, extraction rules, output fields, and entity watchlist. Set `status` to `inactive` while you test the monitor, then change it to `active` when it is ready to run continuously. operationId: createMonitor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MonitorCreate' examples: creditRating: summary: Credit rating downgrade or negative watch value: name: Credit Rating Downgrade or Negative Watch intent: >- Watch for rating downgrades and negative watch placements affecting BlackRock status: inactive search_queries: search_mode: fast query: text: credit rating downgrade negative watch max_chunks: 100 schedule: frequency: 1h structured_output: company: description: The company affected by the rating action. field_type: entity_reference rating_agency: description: The credit rating agency announcing the action. field_type: text action: description: The announced credit rating action. field_type: enum values: - downgrade - negative_watch new_rating: description: The new rating, when stated. field_type: text extraction_instructions: >- Only return a new event when a rating agency announces a downgrade or places the company on negative watch. Exclude analyst recommendations. entity_watchlist: - name: BlackRock Inc. rp_entity_id: HJ95FV mergersAndAcquisitions: summary: M&A activity value: name: M&A Activity Monitor intent: >- Track newly announced acquisitions and material deal-status changes status: inactive search_queries: search_mode: fast query: text: >- announced acquisition merger takeover bid deal approval termination max_chunks: 100 schedule: frequency: 4h structured_output: buyer: description: The acquiring company. field_type: entity_reference target: description: The company being acquired. field_type: entity_reference event_type: description: The transaction development. field_type: enum values: - announced - approved - completed - terminated deal_value_usd_millions: description: The announced transaction value in USD millions. field_type: number extraction_instructions: >- Return confirmed transaction announcements and material lifecycle updates. Exclude market rumors and general deal commentary. responses: '201': description: Monitor created. content: application/json: schema: $ref: '#/components/schemas/MonitorResponse' '422': $ref: '#/components/responses/ValidationError' components: schemas: MonitorCreate: type: object properties: name: type: string description: Short, recognizable monitor name. intent: type: string description: Plain-language description of what should count as an event. status: $ref: '#/components/schemas/MonitorStatus' default: inactive search_queries: $ref: '#/components/schemas/SearchQueries' schedule: $ref: '#/components/schemas/Schedule' structured_output: $ref: '#/components/schemas/StructuredOutput' extraction_instructions: type: string description: >- Rules explaining what to include, what to exclude, and how to interpret matching content. entity_watchlist: type: array description: Optional set of entities the monitor should track. items: $ref: '#/components/schemas/EntityWatchlistItem' required: - intent - schedule MonitorResponse: type: object properties: data: $ref: '#/components/schemas/Monitor' metadata: $ref: '#/components/schemas/Metadata' required: - data - metadata MonitorStatus: type: string enum: - active - inactive description: >- `active` runs on schedule. `inactive` keeps its configuration but does not start new scheduled runs. SearchQueries: type: object description: >- What to search for during each run. Set the search mode and provide the same query object used by [Search documents](/api-reference/search/search-documents#body-query). properties: search_mode: type: string enum: - fast - smart default: fast query: type: object description: >- The [Search documents query object](/api-reference/search/search-documents#body-query), including its search text, filters, external search, chunk limit, and ranking settings. additionalProperties: true required: - search_mode - query additionalProperties: false Schedule: type: object description: How often an active monitor searches for new content. properties: frequency: type: string description: Time between scheduled runs, such as `1h` or `4h`. examples: - 1h - 4h required: - frequency StructuredOutput: type: object description: >- The fields returned with every event. Each property name becomes a field in the response. additionalProperties: $ref: '#/components/schemas/StructuredOutputField' EntityWatchlistItem: type: object description: A company or other Bigdata entity the monitor should track. properties: name: type: string description: Canonical entity name. rp_entity_id: type: string description: Bigdata knowledge graph entity ID. required: - name - rp_entity_id additionalProperties: true Monitor: allOf: - $ref: '#/components/schemas/MonitorCreate' - type: object properties: id: type: string format: uuid created_at: type: string format: date-time required: - id - created_at Metadata: type: object properties: request_id: type: string timestamp: type: string format: date-time required: - request_id - timestamp HTTPValidationError: type: object properties: detail: type: array items: $ref: '#/components/schemas/ValidationError' StructuredOutputField: type: object description: One field to extract for every event. properties: description: type: string description: Instructions explaining what information belongs in this field. field_type: type: string enum: - text - number - enum - entity_reference values: type: array description: Allowed values when `field_type` is `enum`. items: type: string required: - field_type ValidationError: type: object properties: loc: type: array items: anyOf: - type: string - type: integer msg: type: string type: type: string input: {} ctx: type: object additionalProperties: true required: - loc - msg - type responses: ValidationError: description: Validation error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' securitySchemes: API Key Authentication: type: apiKey in: header name: X-API-KEY description: API key created in the Bigdata Developer Platform. ````