Monitors

Create monitor

Create a new AI monitor. Only AI_SIGNAL type is supported; status is required and accepts ACTIVE or DRAFT.

post/v1/api/monitors

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/api/monitors
  • Auth: HTTP bearer

Request body

namestring required

Display name for the monitor. Must be non-blank and at most 256 characters.

status'ACTIVE' | 'DRAFT' nullable

Required initial monitor status. Accepts ACTIVE or DRAFT.

classificationType'EVENT' | 'MENTIONS' | 'TOPIC' required

How matching content is classified. Accepts EVENT, MENTIONS, or TOPIC.

monitoringObjectivestring required

Plain-language objective that defines what the monitor tracks. Must be non-blank and at most 4,096 characters.

promptstring nullable

Optional instructions used to guide monitor processing. Limited to 8,192 characters.

watchlistIdinteger nullable

Numeric ID of a visible watchlist in the monitor's organization to associate with the monitor.

contactPointIdsstring[] nullable

UUIDs of verified, non-archived contact points that receive monitor notifications.

Response

200 - Success

Example response

{
  "data": {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "AI Product Launches",
    "createdAt": "2025-08-01T14:22:10.123Z",
    "updatedAt": "2025-08-12T09:15:44.567Z",
    "status": "ACTIVE",
    "classificationType": "EVENT",
    "monitoringObjective": "Track major AI product launches and model releases from leading technology companies.",
    "prompt": "Focus on official announcements and product releases.",
    "dataSchema": {
      "version": "V1",
      "allowExtra": false,
      "schema": {
        "eventType": {
          "type": "ENUM",
          "description": "Type of AI product announcement",
          "nullable": false,
          "required": true,
          "values": [
            "PRODUCT_LAUNCH",
            "MODEL_RELEASE"
          ]
        },
        "productName": {
          "type": "STRING",
          "description": "Name of the launched product or model",
          "nullable": true,
          "required": true
        },
        "company": {
          "type": "STRING",
          "description": "Company that launched the product",
          "nullable": true,
          "required": true
        }
      }
    },
    "newsletterConfig": null,
    "entityGroups": [],
    "query": {
      "q": "AI OR \"artificial intelligence\"",
      "sourceGroup": [
        "top100"
      ]
    },
    "schedulePolicy": {
      "intervals": [
        {
          "hour": 9,
          "minute": 0
        }
      ],
      "timezoneId": "America/New_York"
    },
    "watchlistId": 42,
    "contactPointIds": [
      "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.