Operations
Create a monitor
Create a monitor for one query. It is all or nothing: if the call fails, no monitor exists.
POST/v1/monitors
Send your API key as Authorization: Bearer. See Authentication. How each option works: Monitors.
Request body
query- What to watch for, as a plain sentence. You cannot change it later.
options.frequency- How often Telem runs the query:
1h,6h,12h,1dor7d. options.include_domains- Only results from these sites and their subdomains, such as
sec.gov. Host names only. options.search- Also search the web for the query on each run, with these options.
{}uses the default search. See Monitors. options.search.num_results- Results for each provider on each run.
options.search.tier- Which fields each result has.
webhook_url- An
httpsURL. Telem sends the new results to it. See Get results by webhook. ttl- How long the monitor lives, such as
12hor7d, at most30d. Without it, the monitor does not expire. agent- The monitor agent checks every result against the query and keeps the ones that match. You read what it keeps in the console. Send
falseto create the monitor without an agent.
More fields: metadata
metadata- Query lineage keys, as in a search.
Response
201
id- The ID of the monitor.
query- What the monitor watches for.
frequency- How often Telem runs the query.
statusactive: Telem runs the query on the schedule.paused: you paused it.ended: its end time passed, or its API key was revoked or expired, and it does not run again. A monitor that nobody polls stops its runs but still showsactive: see Monitors.session_id- The session where Telem records your polls.
created_at- When you created the monitor.
last_polled_at- Your last poll or delivered webhook, or
null. expires_at- When the monitor ends, or
nullwithout attl. webhook_url- Where Telem sends new results, or
null. webhook_secret- The secret to check webhook requests with. Only the response that sets
webhook_urlhas it, so keep it. agent_note- Only in the answer to a create: why the monitor agent did not start, or
null. The monitor then runs without an agent.
Errors
| Status | Code | When |
|---|---|---|
400 | invalid_request | A field is not correct, such as a frequency that is not in the list, or a search provider refused the request. In that case, sending it unchanged will not help. |
400 | invalid_session | The session in metadata is not correct. |
402 | payment_required | The account cannot pay for the monitor. The message says why. |
422 | invalid_request | The body is not valid. For example: an unknown field, an empty query, a webhook_url that is not https, a ttl that is not correct, or an options.search option that the monitor sets itself. |
401 | unauthorized | The API key is missing or not valid. |
403 | The API key has no access to monitors. | |
429 | rate_limited | Your key went over its requests-per-minute cap, or Telem is busy. Wait for the seconds in Retry-After, then try again. |
503 | unavailable | Telem cannot run monitors now. Try again later. |
500 | internal_error | Telem could not create the monitor. No monitor exists. Try again. |
502 | unavailable | The monitor failed. You can send the same request again. |
What each error means and what to do: Errors.