Monitors

Preview a monitor plan and output schema

Compiles a natural-language query into targets, events and relevance criteria, and derives an output schema when output.type is object without a schema. Creates nothing. Compile and create cost 1 ACU. Each run costs 1 ACU per target fetched plus 1 ACU per emitted item. Baseline runs emit nothing.

post/v1/monitors/compile

Request

  • Base URL: https://api.ploid.com
  • URL: https://api.ploid.com/v1/monitors/compile
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

querystring required

Example request

{
  "query": "New LinkedIn posts from Nvidia about AI chips"
}

Response

Compiled plan

metaobject required

Changes

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