> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Perigon

The Perigon connector lets your AI agent act in each user's Perigon account. Each user connects their own Perigon access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 50 tools.

**Authentication:** Bearer Token
**Categories:** Search, Analytics
**Tools:** 50: 35 read, 11 write, 4 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=PERIGON)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Perigon connection

   In **AgentKit > Connections**, create a Perigon connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'perigon'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Perigon:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'perigon_articles_search',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "perigon"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Perigon:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="perigon_articles_search",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Perigon credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'perigon_articles_refresh_job_get',
  toolInput: {
    id: '<id>',
  },
  connector: 'perigon',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="perigon_articles_refresh_job_get",
    tool_input={
        "id": "<id>",
    },
    connection_name="perigon",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `perigon_articles_refresh_job_get`

Get Article Refresh Job · Read-only

Get the status and results of an article refresh job.
Returns jobId, status and results with each article's articleId, status, reason, data and computedAt.
Use after perigon_articles_refresh_job_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Job id returned by perigon_articles_refresh_job_create. Example: rj_3f1c7b9e2a4d4e8f.

Example input: `{"id":"<id>"}`

### `perigon_articles_refresh_peek`

Peek Refreshed Articles · Read-only

Read whatever refreshed article data is already cached for some article IDs, without starting a refresh.
Returns results with any cached refreshed data and its fetchedAt and validatedAt times.
Use perigon_articles_refresh_job_create to request a refresh.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `article_ids` (`array`, required): articleId values to look up. Example: ["8f1e2d3c4b5a69788776655443322110"]

Example input: `{"article_ids":["8f1e2d3c4b5a69788776655443322110"]}`

### `perigon_articles_search`

Search Articles · Read-only

Search Perigon's news index of 230,000+ sources by keyword and filters such as date, source, topic, company, person, location, language and sentiment.
Returns status, numResults and articles with articleId, url, title, description, content, pubDate, source, authorsByline, language, country, clusterId and score.
Use this for precise keyword search. Use perigon_news_vector_search for natural-language questions, perigon_stories_search for story clusters and perigon_summarize for a written summary.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `article_id` (`array`, optional): Retrieve specific news articles by their unique article identifiers. Multiple IDs can be provided to return a collection of specific articles. Example: 8f1e2d3c4b5a69788776655443322110.
- `author` (`array`, optional): Filter articles by specific author names. Works as an exact match for each name. Multiple values create an OR filter to find articles by any of the specified authors. Example: Jane Smith.
- `category` (`array`, optional): Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use 'none' to search uncategorized articles. Example: Tech.
- `city` (`array`, optional): Filters articles where a specified city plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the urban area in question. If multiple parameters are passed, they will be applied as OR operations. Example: San Francisco.
- `cluster_id` (`array`, optional): Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance. Example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.
- `company_domain` (`array`, optional): Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint. Example: apple.com.
- `company_name` (`string`, optional): Filter articles by company name mentions. Performs an exact match on company names. Example: Apple Inc.
- `company_symbol` (`array`, optional): Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint. Example: AAPL.
- `content` (`string`, optional): Search within the full article body content. Supports Boolean logic, exact phrase matching with quotes, and wildcards for comprehensive content searching. Example: layoffs.
- `country` (`array`, optional): Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations. Example: us.
- `desc` (`string`, optional): Search within article description fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching. Example: acquisition.
- `exclude_label` (`array`, optional): Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels. Example: Paid News.
- `exclude_source` (`array`, optional): Exclude articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an AND-exclude filter. Example: dailymail.co.uk.
- `from` (`string`, optional): Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format. Example: 2025-01-01.
- `journalist_id` (`array`, optional): Filter by unique journalist identifiers which can be found through the Journalist API or in the matchedAuthors field. Multiple values create an OR filter. Example: 4bd0e2c7-8f6a-4a3b-9c1d-2e3f4a5b6c7d.
- `label` (`array`, optional): Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter. Example: Opinion.
- `language` (`array`, optional): Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter. Example: en.
- `medium` (`array`, optional): Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter. Example: Article.
- `negative_sentiment_from` (`number`, optional): Filter articles with a negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone. Example: 10.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `paywall` (`boolean`, optional): Filter to show only results where the source has a paywall (true) or does not have a paywall (false). Example: true.
- `person_name` (`array`, optional): Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint. Example: Elon Musk.
- `positive_sentiment_from` (`number`, optional): Filter articles with a positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone. Example: 10.
- `q` (`string`, optional): Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `show_num_results` (`boolean`, optional): Whether to show the total number of all matched articles. Default value is false which makes queries a bit more efficient but also counts up to 10000 articles. Example: true.
- `show_reprints` (`boolean`, optional): Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites. Example: true.
- `size` (`integer`, optional): The number of articles to return per page in the paginated response. Example: 10.
- `sort_by` (`string`, optional): Determines the article sorting order. Options include relevance (default), date/pubDate (newest publication date first), reverseDate (oldest publication date first), addDate (newest ingestion date first), reverseAddDate (oldest ingestion date first), and refreshDate (most recently updated in system first, often identical to addDate). Example: relevance. One of: `relevance`, `date`, `reverseDate`, `reverseAddDate`, `addDate`, `pubDate`, `refreshDate`.
- `source` (`array`, optional): Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter. Example: cnn.com.
- `source_group` (`array`, optional): Filter articles using Perigon's curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles. Example: top100.
- `state` (`array`, optional): Filters articles where a specified state plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the state in question. If multiple parameters are passed, they will be applied as OR operations. Example: CA.
- `title` (`string`, optional): Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations. Example: earnings.
- `to` (`string`, optional): Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format. Example: 2025-01-31.
- `topic` (`array`, optional): Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter. Example: Markets.
- `url` (`string`, optional): Search query on the url field. Semantic similar to q parameter. E.g. could be used for querying certain website sections, e.g. source=cnn.com&url=travel. Example: https://www.reuters.com/technology/example-article.
- `watchlist` (`array`, optional): Filter articles using watchlists of people and companies. Multiple values create an OR filter to include articles mentioning any entity from the specified watchlists. Example: my-watchlist.

Example input: `{}`

### `perigon_companies_search`

Search Companies · Read-only

Search Perigon's company database by name, domain, ticker, industry, country or size.
Returns status, numResults and results with id, name, domains, description, ceo, industry, sector, country, fullTimeEmployees, address and monthlyVisits.
Use a company id or domain to filter perigon_articles_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `country` (`array`, optional): Filter by company headquarters country. Multiple values create an OR filter. Example: us.
- `domain` (`array`, optional): Filter by company domains or websites (e.g., apple.com, microsoft.com). Multiple values create an OR filter. Example: techcrunch.com.
- `exchange` (`array`, optional): Filter by stock exchange where companies are listed (e.g., NASDAQ, NYSE). Multiple values create an OR filter. Example: NASDAQ.
- `id` (`array`, optional): Filter by unique company identifiers. Multiple values create an OR filter. Example: 4bd0e2c7-8f6a-4a3b-9c1d-2e3f4a5b6c7d.
- `industry` (`string`, optional): Filter by company industry classifications. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: Software.
- `name` (`string`, optional): Search within company names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: Tesla.
- `num_employees_from` (`integer`, optional): Filter for companies with at least this many employees. Example: 10.
- `num_employees_to` (`integer`, optional): Filter for companies with no more than this many employees. Example: 10.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `q` (`string`, optional): Primary search query for filtering companies across name, alternative names, domains, and ticker symbols. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `sector` (`string`, optional): Filter by company sector classifications. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: Technology.
- `size` (`integer`, optional): The number of companies to return per page in the paginated response. Example: 10.
- `symbol` (`array`, optional): Filter by company stock ticker symbols (e.g., AAPL, MSFT, GOOGL). Multiple values create an OR filter. Example: TSLA.

Example input: `{}`

### `perigon_contact_point_get`

Get Contact Point · Read-only

Get one contact point.
Returns data with the contact point's uuid, type, status, name, email or webhookUrl and verified.
Use perigon_contact_points_list to find UUIDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the contact point. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.

Example input: `{"uuid":"<uuid>"}`

### `perigon_contact_points_list`

List Contact Points · Read-only

List the notification contact points (email and webhook destinations) in your organization.
Returns total and data with each contact point's uuid, type, status, name, email or webhookUrl and verified.
Use contact point UUIDs in perigon_monitor_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Field to sort by: createdAt or updatedAt. Defaults to createdAt. Example: createdAt. One of: `createdAt`, `updatedAt`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.
- `status` (`array`, optional): Only items with these statuses. Example: ACTIVE.
- `type` (`array`, optional): Only contact points of these types. Example: EMAIL.

Example input: `{}`

### `perigon_journalist_get`

Get Journalist · Read-only

Get one journalist's profile.
Returns id, name, fullName, headline, description, title, locations, topTopics, topSources and social handles.
Use a journalist id from perigon_journalists_search or an article's authors.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Journalist id. Example: 4bd0e2c7-8f6a-4a3b-9c1d-2e3f4a5b6c7d.

Example input: `{"id":"<id>"}`

### `perigon_journalists_search`

Search Journalists · Read-only

Search journalists by name, outlet, topic, category or location.
Returns status, numResults and results with id, name, title, headline, locations, topTopics, topSources, topCategories, avgMonthlyPosts and twitterHandle.
Use perigon_journalist_get for one journalist.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`array`, optional): Filter journalists by the top categories they cover. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. (Searches inside the topCategories data field.). Example: Tech.
- `country` (`array`, optional): Filter journalists by countries they commonly cover in their reporting. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). Multiple values create an OR filter. Example: us.
- `label` (`array`, optional): Filter journalists by the most common label tagged to the articles they publish. This accepts labels like 'Opinion' or 'Pop Culture'. (Searches the topLabels data field.). Example: Opinion.
- `min_monthly_posts` (`integer`, optional): Filter for journalists who publish at least this many articles per month. Used to identify more active journalists. Example: 100.
- `name` (`string`, optional): Search specifically within journalist names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: Tesla.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `q` (`string`, optional): Primary search query for filtering journalists based on their name, title, and Twitter bio. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `show_num_results` (`boolean`, optional): Controls whether to return the exact result count. When false (default), counts are capped at 10,000 for performance reasons. Set to true for precise counts in smaller result sets. Example: true.
- `size` (`integer`, optional): The number of journalists to return per page in the paginated response. Example: 10.
- `sort_by` (`string`, optional): Sort journalists from highest to lowest by avgMonthlyPosts, linkedinConnections, or linkedinFollowers. When omitted, results are sorted by relevance. Example: avgMonthlyPosts. One of: `avgMonthlyPosts`, `linkedinConnections`, `linkedinFollowers`.
- `source` (`array`, optional): Filter journalists by the publisher domains they write for. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter. Example: cnn.com.
- `topic` (`array`, optional): Filter journalists by the top topics they cover. Topics are more specific themes that the article is about. Examples of topics: 'Economy', 'Real Estate', 'Cryptocurrency'. If multiple parameters are passed, they will be applied as OR operations. (Searches inside the topCategories data field.). Example: Markets.
- `twitter` (`string`, optional): Filter journalists by their exact Twitter handle, without the @ symbol. Example: karaswisher.

Example input: `{}`

### `perigon_limits_get`

Get API Limits · Read-only

Get your Perigon plan's request limits and current usage.
Returns data with your plan's limits and usage, and the status of any API keys checked.
Use this to check quota before large searches.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `api_keys` (`array`, optional): Optional list of API keys whose validity and status should be checked. Each key is reported as valid only if it exists and belongs to your account. Example: 00000000-0000-0000-0000-000000000000.

Example input: `{}`

### `perigon_linkedin_company_posts_list`

List LinkedIn Company Posts · Read-only

List recent posts from a LinkedIn company page.
Returns status, numResults, results (activityType, url, text, createdAt, likes, comments, shares, author) and nextCursor.
Pass nextCursor as cursor for the next page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): LinkedIn company page URL, e.g. https://www.linkedin.com/company/microsoft. Example: https://www.linkedin.com/company/perigon/.
- `cursor` (`string`, optional): nextCursor from the previous page. Example: eyJvZmZzZXQiOjIwfQ.
- `type` (`string`, optional): Kind of posts to return. Defaults to all posts. Example: ALL. One of: `ALL`, `ARTICLES`, `DOCUMENTS`.

Example input: `{"url":"<url>"}`

### `perigon_linkedin_person_activity_list`

List LinkedIn Person Activity · Read-only

List recent LinkedIn activity (posts, comments, reactions) of a person.
Returns status, numResults, results (activityType, url, text, createdAt, likes, comments, shares, author) and nextCursor.
Pass nextCursor as cursor for the next page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): LinkedIn profile URL, e.g. https://www.linkedin.com/in/williamhgates. Example: https://www.linkedin.com/in/satyanadella/.
- `cursor` (`string`, optional): nextCursor from the previous page. Example: eyJvZmZzZXQiOjIwfQ.
- `type` (`string`, optional): Kind of activity to return. Defaults to posts. Example: POSTS. One of: `POSTS`, `COMMENTS`, `REACTIONS`.

Example input: `{"url":"<url>"}`

### `perigon_linkedin_posts_search`

Search LinkedIn Posts · Read-only

Search public LinkedIn posts by keyword.
Returns status, numResults, results (urn, url, text, postedAt, author, reactions, likes, comments) and nextPage.
Use perigon_linkedin_company_posts_list or perigon_linkedin_person_activity_list for one company or person.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `q` (`string`, required): Search keywords. Example: "artificial intelligence" AND regulation.
- `author_title` (`string`, optional): Only return posts by authors whose title matches this value. Example: CEO.
- `content_type` (`string`, optional): Only return posts with this type of content. Example: PHOTOS. One of: `PHOTOS`, `VIDEOS`, `JOBS`, `LIVE_VIDEOS`, `DOCUMENTS`.
- `date_posted` (`string`, optional): Only return posts published within this time window. Example: PAST_24H. One of: `PAST_24H`, `PAST_WEEK`, `PAST_MONTH`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 10.
- `sort_by` (`string`, optional): Sort order of the results. Example: DATE_POSTED. One of: `DATE_POSTED`, `RELEVANCE`.

Example input: `{"q":"artificial intelligence"}`

### `perigon_monitor_events_list`

List Monitor Events · Read-only

List the events a monitor detected, newest first by default.
Returns total and data with each event's uuid, eventDate, eventType, data (the extracted fields), summary, entities and related articles.
Use this to read what a monitor found.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor whose events to retrieve. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.
- `event_type` (`string`, optional): Filter for events with this exact event type. Example: NEW_EVENT.
- `from` (`string`, optional): Filter for events created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-01.
- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Required field used to sort events. Accepts createdAt, updatedAt, or eventDate. Defaults to createdAt. Example: createdAt. One of: `createdAt`, `updatedAt`, `eventDate`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.
- `to` (`string`, optional): Filter for events created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-31.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_get`

Get Monitor · Read-only

Get one monitor's full configuration and status.
Returns data with the monitor's uuid, name, status, classificationType, monitoringObjective, prompt, query, dataSchema, entityGroups, watchlistId and contactPointIds.
Use perigon_monitor_events_list for what it found.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_newsletters_list`

List Monitor Newsletters · Read-only

List the newsletters a monitor generated.
Returns total and data with each newsletter's uuid, title, content, articles and stories.
Use perigon_monitor_summaries_list for periodic summaries.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor whose newsletters to retrieve. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.
- `from` (`string`, optional): Filter for newsletters created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-01.
- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Required field used to sort newsletters. Accepts createdAt or updatedAt. Defaults to createdAt. Example: createdAt. One of: `createdAt`, `updatedAt`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.
- `title` (`string`, optional): Filter by newsletter title using a case-insensitive partial match. Example: earnings.
- `to` (`string`, optional): Filter for newsletters created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-31.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_summaries_list`

List Monitor Summaries · Read-only

List the periodic summaries a monitor produced.
Returns total and data with each summary's text and timestamps.
Use perigon_monitor_events_list for individual events.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor whose summaries to retrieve. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.
- `from` (`string`, optional): Filter for summaries created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-01.
- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Required field used to sort summaries. Accepts createdAt or updatedAt. Defaults to createdAt. Example: createdAt. One of: `createdAt`, `updatedAt`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.
- `to` (`string`, optional): Filter for summaries created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-31.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitors_list`

List Monitors · Read-only

List the AI news monitors in your Perigon organization.
Returns total and data with each monitor's uuid, name, status, classificationType, monitoringObjective, query and timestamps.
Use perigon_monitor_get for one monitor's full configuration.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `classification_type` (`array`, optional): Filter by classification type: EVENT, MENTIONS, or TOPIC. Multiple values are combined with OR. Example: EVENT.
- `name` (`string`, optional): Filter by monitor name using a case-insensitive partial match. Example: Tesla.
- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Required field used to sort monitors. Accepts createdAt or updatedAt. Defaults to createdAt. Example: createdAt. One of: `createdAt`, `updatedAt`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.
- `status` (`array`, optional): Filter by status: DRAFT, ACTIVE, STOPPED, or ARCHIVED. When omitted, archived monitors are excluded. Example: DRAFT.

Example input: `{}`

### `perigon_news_vector_search`

Semantic Search News · Read-only

Search news from the past 6 months by meaning with a natural-language prompt instead of keywords.
Returns status and results, each with a relevance score and the article data.
Use this for questions or fuzzy topics. Use perigon_articles_search for exact keywords and filters.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `prompt` (`string`, required): Natural-language query describing the news you want. Example: How are European regulators responding to generative AI?.
- `filter` (`object`, optional): Extra article filters with the same field names as perigon_articles_search, for example source, category or country, combinable with AND, OR and NOT keys. Example: {"category": ["Tech"], "country": ["us"]}
- `page` (`integer`, optional): Page number to return, starting at 0. Example: 0.
- `pub_date_from` (`string`, optional): Only articles published after this date (ISO 8601 or yyyy-mm-dd). Example: 2025-01-01.
- `pub_date_to` (`string`, optional): Only articles published before this date (ISO 8601 or yyyy-mm-dd). Example: 2025-01-31.
- `show_reprints` (`boolean`, optional): Include wire reprints (AP, Reuters) carried by many sources. Default true. Example: false.
- `size` (`integer`, optional): Results per page. Example: 10.

Example input: `{"prompt":"<prompt>"}`

### `perigon_people_search`

Search People · Read-only

Search public figures by name, Wikidata ID or occupation.
Returns status, numResults and results with wikidataId, name, description, aliases, occupation, position, politicalParty and image.
Use a person's name or wikidataId to filter perigon_articles_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, optional): Search by person's name. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: Tesla.
- `occupation_id` (`array`, optional): Filter by Wikidata occupation IDs (e.g., Q82955 for politician, Q33999 for actor, Q19546 for businessman). Finds people with specific professions. Multiple values create an OR filter. Example: Q131524.
- `occupation_label` (`string`, optional): Search by occupation name (e.g., politician, actor, CEO, athlete). Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: entrepreneur.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `size` (`integer`, optional): The number of people to return per page in the paginated response. Example: 10.
- `wikidata_id` (`array`, optional): Filter by Wikidata entity IDs (e.g., Q7747, Q937). These are unique identifiers from Wikidata.org that precisely identify public figures and eliminate name ambiguity. Multiple values create an OR filter. Example: Q317521.

Example input: `{}`

### `perigon_reddit_posts_search`

Search Reddit Posts · Read-only

Search Reddit posts by keyword, optionally in one subreddit.
Returns status, numResults, results (id, title, text, author, subreddit, url, score, numComments) and nextCursor.
Pass nextCursor as cursor for the next page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `q` (`string`, required): Search query. Example: "artificial intelligence" AND regulation.
- `cursor` (`string`, optional): nextCursor from the previous page. Example: eyJvZmZzZXQiOjIwfQ.
- `sort` (`string`, optional): Sort order of the results. Example: RELEVANCE. One of: `RELEVANCE`, `HOT`, `TOP`, `NEW`, `COMMENTS`.
- `subreddit` (`string`, optional): Restrict the search to a subreddit (without the r/ prefix). Example: technology.
- `time` (`string`, optional): Time window of the results. Only applies to the TOP sort. Example: HOUR. One of: `HOUR`, `DAY`, `WEEK`, `MONTH`, `YEAR`, `ALL`.

Example input: `{"q":"artificial intelligence"}`

### `perigon_source_group_get`

Get Source Group · Read-only

Get one source group.
Returns data with the source group's id, name, displayName, description and domains.
Use perigon_source_groups_list to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric ID of the source group. Example: 1234.

Example input: `{"id":1234}`

### `perigon_source_group_resolve`

Resolve Source Group · Read-only

Look up a source group by name.
Returns data with the matching source groups.
Use perigon_source_groups_list to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`array`, required): Source group names to resolve (max 100). Example: my-trusted-sources.

Example input: `{"name":[]}`

### `perigon_source_groups_list`

List Source Groups · Read-only

List your organization's source groups (named sets of news domains).
Returns total and data with each source group's id, name, displayName, description and domains.
Use a source group name as source_group in perigon_articles_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `domain` (`string`, optional): Only source groups that contain this domain. Example: techcrunch.com.
- `name` (`string`, optional): Only items whose name matches this value. Example: Tesla.
- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Field to sort by: createdAt or updatedAt. Defaults to createdAt. Example: id. One of: `id`, `createdAt`, `updatedAt`, `name`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.

Example input: `{}`

### `perigon_sources_search`

Search Sources · Read-only

Search news sources (publishers) by domain, name, location, topic, traffic or paywall.
Returns status, numResults and results with id, domain, name, description, avgMonthlyPosts, paywall, location, topCategories, topTopics and bias ratings.
Use a source domain to filter perigon_articles_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`array`, optional): Filter sources by their primary content categories such as Politics, Tech, Sports, Business, or Finance. Returns sources that frequently cover these topics. Multiple values create an OR filter. Example: Tech.
- `country` (`array`, optional): Filter sources by countries they commonly cover in their reporting. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). See documentation for supported country codes. Multiple values create an OR filter. Example: us.
- `domain` (`array`, optional): Filter by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com, us?.nytimes.com). Multiple values create an OR filter. Example: techcrunch.com.
- `label` (`array`, optional): Filter sources by their content label patterns (e.g., Opinion, Paid-news, Non-news). Returns sources where the specified label is common in their published content. See documentation for all available labels. Multiple values create an OR filter. Example: Opinion.
- `min_monthly_posts` (`integer`, optional): Filter for sources that publish at least this many articles per month. Used to target publishers by content volume. Example: 100.
- `min_monthly_visits` (`integer`, optional): Filter for sources with at least this many monthly visitors. Used to target publishers by audience size. Example: 100000.
- `name` (`string`, optional): Search by source name or alternative names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: Tesla.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `paywall` (`boolean`, optional): Filter by paywall status. Set to true to find sources with paywalls, or false to find sources without paywalls. Example: true.
- `show_num_results` (`boolean`, optional): Controls whether to return the exact result count. When false (default), counts are capped at 10,000 for performance reasons. Set to true for precise counts in smaller result sets. Example: true.
- `size` (`integer`, optional): The number of sources to return per page in the paginated response. Example: 10.
- `sort_by` (`string`, optional): Determines the source sorting order. Options include relevance (default, best match to query), globalRank (by overall traffic and popularity), monthlyVisits (by total monthly visitor count), and avgMonthlyPosts (by number of articles published monthly). Example: globalRank. One of: `globalRank`, `relevance`, `monthlyVisits`, `avgMonthlyPosts`.
- `source_country` (`array`, optional): Filter for local publications based in specific countries. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). See documentation for supported country codes. Multiple values create an OR filter. Example: us.
- `source_group` (`string`, optional): Filter by predefined publisher bundles (e.g., top100, top50tech). Returns all sources within the specified group. See documentation for available source groups. Example: top100.
- `topic` (`array`, optional): Filter sources by their frequently covered topics (e.g., Markets, Cryptocurrency, Climate Change). Returns sources where the specified topic is among their top 10 covered areas. Multiple values create an OR filter. Example: Markets.

Example input: `{}`

### `perigon_stories_search`

Search Stories · Read-only

Search story clusters: groups of articles about the same event, with AI summaries, key points and trend data.
Returns status, numResults and results with id (cluster id), name, summary, shortSummary, keyPoints, questions, uniqueSources, sentiment, uniqueCount and timestamps.
Use this to follow developing events. Use perigon_articles_search with cluster_id for a story's articles and perigon_story_history_get for its changes over time.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`array`, optional): Filter stories by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use 'none' to find uncategorized stories. Categories are derived from the articles within each story. Multiple values create an OR filter. Example: Tech.
- `city` (`array`, optional): Filter local news by city. Applies only to local news, when this param is passed non-local news will not be returned. If multiple parameters are passed, they will be applied as OR operations. Example: San Francisco.
- `cluster_id` (`array`, optional): Filter to specific stories using their unique identifiers. Each clusterId represents a distinct story that groups related articles. Multiple values create an OR filter. Example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.
- `company_domain` (`array`, optional): Filter stories by domains of top mentioned companies (e.g., apple.com). Returns stories where companies with these domains appear prominently. For available company entities, consult the /companies endpoint. Example: apple.com.
- `company_name` (`string`, optional): Filter stories by names of top mentioned companies. Performs an exact match on company names in the topCompanies field. Example: Apple Inc.
- `company_symbol` (`array`, optional): Filter stories by stock symbols of top mentioned companies. Returns stories where companies with these symbols appear prominently. For available company entities and their symbols, consult the /companies endpoint. Example: AAPL.
- `country` (`array`, optional): Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations. Example: us.
- `expand_articles` (`boolean`, optional): Preview 5 articles from the cluster. Example: true.
- `from` (`string`, optional): Filter for stories created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-01.
- `min_cluster_size` (`integer`, optional): Filter by minimum cluster size. Minimum cluster size filter applies to number of unique articles. Example: 10.
- `min_unique_sources` (`integer`, optional): Specifies the minimum number of unique sources required for a story to appear in results. Higher values return more significant stories covered by multiple publications. Default is 3. Example: 3.
- `name` (`string`, optional): Search specifically within story names. Supports Boolean operators, exact phrases with quotes, and wildcards for matching name variations. Example: Tesla.
- `negative_sentiment_from` (`number`, optional): Filter stories with an aggregate negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone. Example: 10.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `person_name` (`string`, optional): Filter stories by exact name matches of top mentioned people. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint. Example: Elon Musk.
- `positive_sentiment_from` (`number`, optional): Filter stories with an aggregate positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone. Example: 10.
- `q` (`string`, optional): Primary search query for filtering stories based on their name, summary, and key points. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `show_duplicates` (`boolean`, optional): Stories are deduplicated by default. If a story is deduplicated, all future articles are merged into the original story. duplicateOf field contains the original cluster Id. When showDuplicates=true, all stories are shown. Example: true.
- `show_num_results` (`boolean`, optional): Show total number of results. By default set to false, will cap result count at 10000. Example: true.
- `size` (`integer`, optional): The number of articles to return per page in the paginated response. Example: 10.
- `sort_by` (`string`, optional): Determines the story sorting order. Options include createdAt (default, when stories first emerged), updatedAt (when stories received new articles, best for tracking developing events), relevance (best match to query), count (by unique article count), and totalCount (by total article count including reprints). Example: createdAt. One of: `createdAt`, `updatedAt`, `relevance`, `count`, `totalCount`.
- `source` (`array`, optional): Filter stories that contain articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). A story will match if it contains at least one article from any of the specified sources. Multiple values create an OR filter. Example: cnn.com.
- `source_group` (`array`, optional): Filter stories that contain articles from publishers in Perigon's curated bundles (e.g., top100, top25crypto). A story will match if it contains at least one article from any publisher in the specified bundles. Multiple values create an OR filter. Example: top100.
- `state` (`array`, optional): Filter local news by state. Applies only to local news, when this param is passed non-local news will not be returned. If multiple parameters are passed, they will be applied as OR operations. Example: CA.
- `to` (`string`, optional): Filter for stories created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-31.
- `topic` (`array`, optional): Filter stories by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and stories can include multiple topics based on their constituent articles. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter. Example: Markets.
- `updated_from` (`string`, optional): Filter for stories that received new articles after this date. Useful for tracking developing news events or evolving storylines. Example: 2025-01-01.
- `updated_to` (`string`, optional): Filter for stories that received new articles before this date. Useful for tracking developing news events or evolving storylines. Example: 2025-01-01T00:00:00.

Example input: `{}`

### `perigon_story_history_get`

Get Story History · Read-only

Get how stories' summaries and key points changed over time.
Returns status, numResults and results with clusterId, name, summary, keyPoints, changelog and triggeredAt.
Use this with a cluster_id from perigon_stories_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `changelog_exists` (`boolean`, optional): Filter by whether a history record contains a changelog. Use true to require one or false to require its absence. Example: true.
- `cluster_id` (`array`, optional): Filter history records by story cluster ID. Multiple values are combined with OR. Example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.
- `from` (`string`, optional): Filter for history records created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-01.
- `page` (`integer`, optional): Zero-based page number. From 0 to 10000. See the Pagination section for limitations. Example: 10.
- `size` (`integer`, optional): Number of stories results per page, from 0 to 100. Example: 10.
- `sort_by` (`string`, optional): Field used to sort history records in descending order. Accepts createdAt or triggeredAt and defaults to createdAt. Example: createdAt. One of: `createdAt`, `triggeredAt`.
- `to` (`string`, optional): Filter for history records created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-31.

Example input: `{}`

### `perigon_story_stats_get`

Get Story Count Statistics · Read-only

Count matching stories over time, split by hour, day, week or month.
Returns status, numResults and results with story counts per time bucket.
Use this to chart how much a topic is being covered.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `split_by` (`string`, required): Time interval used to group story counts. Accepts hour, day, week, or month and defaults to month. Use none to return a single total count, without a date, for the whole range. Example: hour. One of: `hour`, `day`, `week`, `month`, `none`.
- `category` (`array`, optional): Filter stories by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use 'none' to find uncategorized stories. Categories are derived from the articles within each story. Multiple values create an OR filter. Example: Tech.
- `cluster_id` (`array`, optional): Filter to specific stories using their unique identifiers. Each clusterId represents a distinct story that groups related articles. Multiple values create an OR filter. Example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.
- `company_domain` (`array`, optional): Filter stories by domains of top mentioned companies (e.g., apple.com). Returns stories where companies with these domains appear prominently. For available company entities, consult the /companies endpoint. Example: apple.com.
- `company_name` (`string`, optional): Filter stories by names of top mentioned companies. Performs an exact match on company names in the topCompanies field. Example: Apple Inc.
- `company_symbol` (`array`, optional): Filter stories by stock symbols of top mentioned companies. Returns stories where companies with these symbols appear prominently. For available company entities and their symbols, consult the /companies endpoint. Example: AAPL.
- `country` (`array`, optional): Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations. Example: us.
- `from` (`string`, optional): Filter for stories created on or after this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-01.
- `min_cluster_size` (`integer`, optional): Filter by minimum cluster size. Minimum cluster size filter applies to number of unique articles. Example: 10.
- `min_unique_sources` (`integer`, optional): Specifies the minimum number of unique sources required for a story to appear in results. Higher values return more significant stories covered by multiple publications. Default is 3. Example: 3.
- `name` (`string`, optional): Search specifically within story names. Supports Boolean operators, exact phrases with quotes, and wildcards for matching name variations. Example: Tesla.
- `person_name` (`string`, optional): Filter stories by exact name matches of top mentioned people. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint. Example: Elon Musk.
- `q` (`string`, optional): Primary search query for filtering stories based on their name, summary, and key points. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `source` (`array`, optional): Filter stories that contain articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). A story will match if it contains at least one article from any of the specified sources. Multiple values create an OR filter. Example: cnn.com.
- `source_group` (`array`, optional): Filter stories that contain articles from publishers in Perigon's curated bundles (e.g., top100, top25crypto). A story will match if it contains at least one article from any publisher in the specified bundles. Multiple values create an OR filter. Example: top100.
- `time_zone` (`string`, optional): IANA time zone used to align interval buckets (e.g. America/Chicago). Defaults to UTC. Applies to intervalArticleCounts. Example: America/New_York.
- `to` (`string`, optional): Filter for stories created on or before this date. Accepts ISO 8601 or yyyy-mm-dd format. Example: 2025-01-31.
- `topic` (`array`, optional): Filter stories by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and stories can include multiple topics based on their constituent articles. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter. Example: Markets.

Example input: `{"split_by":"hour"}`

### `perigon_summarize`

Summarize News · Read-only

Write one concise AI summary from up to 100 news articles matching a search, guided by your prompt.
Returns status, numResults, summary and results (the source articles).
Use this for briefings. Use perigon_articles_search to just list articles.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`array`, optional): Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use 'none' to search uncategorized articles. Example: Tech.
- `cluster_id` (`array`, optional): Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance. Example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.
- `company_domain` (`array`, optional): Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint. Example: apple.com.
- `company_name` (`string`, optional): Filter articles by company name mentions. Performs an exact match on company names. Example: Apple Inc.
- `company_symbol` (`array`, optional): Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint. Example: AAPL.
- `country` (`array`, optional): Country code to filter by country. If multiple parameters are passed, they will be applied as OR operations. Example: us.
- `exclude_label` (`array`, optional): Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels. Example: Paid News.
- `from` (`string`, optional): Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format. Example: 2025-01-01.
- `label` (`array`, optional): Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter. Example: Opinion.
- `language` (`array`, optional): Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter. Example: en.
- `max_article_count` (`integer`, optional): Number of matching articles to summarize, 1 to 100. Example: 20.
- `max_tokens` (`integer`, optional): Maximum number of tokens to generate. Example: 800.
- `medium` (`array`, optional): Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter. Example: Article.
- `method` (`string`, optional): ARTICLES uses the top matching articles; CLUSTERS uses the first article of each of the top stories. Example: ARTICLES. One of: `ARTICLES`, `CLUSTERS`.
- `model` (`string`, optional): LLM used to write the summary. Example: gpt-6-luna. One of: `gpt-6-luna`, `gpt-6.1-sol`, `openai/gpt-oss-120b`.
- `person_name` (`array`, optional): Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint. Example: Elon Musk.
- `prompt` (`string`, optional): Instructions for how to write the summary, up to 2,048 characters. Example: Summarize the key regulatory developments and their likely impact.
- `q` (`string`, optional): Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `returned_article_count` (`integer`, optional): Number of source articles to return with the summary, 1 to 100 and not more than max_article_count. Example: 5.
- `show_reprints` (`boolean`, optional): Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites. Example: true.
- `source` (`array`, optional): Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter. Example: cnn.com.
- `source_group` (`array`, optional): Filter articles using Perigon's curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles. Example: top100.
- `summarize_fields` (`array`, optional): Article fields to feed the summarizer, up to three of TITLE, CONTENT, SUMMARY. Example: ["TITLE", "SUMMARY"]
- `temperature` (`number`, optional): Sampling temperature from 0 to 2 (ignored by the gpt-6 models). Example: 0.3.
- `title` (`string`, optional): Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations. Example: earnings.
- `to` (`string`, optional): Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format. Example: 2025-01-31.
- `topic` (`array`, optional): Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter. Example: Markets.
- `url` (`string`, optional): Search query on the url field. Semantic similar to q parameter. E.g. could be used for querying certain website sections, e.g. source=cnn.com&url=travel. Example: https://www.reuters.com/technology/example-article.

Example input: `{}`

### `perigon_topics_list`

List Topics · Read-only

List Perigon's topic tags, optionally filtered by name, category or subcategory.
Returns total and data with each topic's id, name and labels (category and subcategory).
Use topic names to filter perigon_articles_search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`string`, optional): Filter topics by broad article categories such as Politics, Tech, Sports, Business, Finance, Entertainment, etc. Example: Tech.
- `name` (`string`, optional): Search for topics by exact name or partial text match. Does not support wildcards. Examples include Markets, Cryptocurrency, Climate Change, etc. Example: Tesla.
- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `size` (`integer`, optional): The number of topics to return per page in the paginated response. Example: 10.
- `subcategory` (`string`, optional): Filter topics by their specific subcategory. Subcategories provide more granular classification beyond the main category, such as TV or Event. Example: AI.

Example input: `{}`

### `perigon_watchlist_get`

Get Watchlist · Read-only

Get one watchlist.
Returns data with the watchlist's id, name, displayName, description, people, companies and visible.
Use perigon_watchlists_list to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric ID of the watchlist. Example: 1234.

Example input: `{"id":1234}`

### `perigon_watchlist_resolve`

Resolve Watchlist · Read-only

Look up a watchlist by name.
Returns data with the matching watchlists.
Use perigon_watchlists_list to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`array`, required): Watchlist names to resolve (max 100). Example: key-accounts.

Example input: `{"name":[]}`

### `perigon_watchlists_list`

List Watchlists · Read-only

List your organization's watchlists (named sets of people and companies).
Returns total and data with each watchlist's id, name, displayName, description, people and companies.
Use a watchlist name in perigon_articles_search or its id in perigon_monitor_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, optional): Filter watchlists by name (case-insensitive, partial match). Example: Tesla.
- `page` (`integer`, optional): Zero-based page number to retrieve. Defaults to 0. Example: 10.
- `size` (`integer`, optional): Number of results per page. Must be between 1 and 100; defaults to 10. Example: 10.
- `sort_by` (`string`, optional): Field to sort by: createdAt or updatedAt. Defaults to createdAt. Example: id. One of: `id`, `createdAt`, `updatedAt`, `name`. Default: `createdAt`.
- `sort_order` (`string`, optional): Required direction used to sort results. Accepts asc or desc. Defaults to desc. Example: asc. One of: `asc`, `desc`. Default: `desc`.

Example input: `{}`

### `perigon_wikipedia_search`

Search Wikipedia · Read-only

Search Wikipedia pages and sections by keyword, title, Wikidata ID or page views.
Returns status, numResults and results with wikiTitle, url, summary, sections, wikidataId and revision details.
Use perigon_wikipedia_vector_search for natural-language questions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): The specific page of results to retrieve in the paginated response. Starts at 0. Example: 10.
- `pageviews_from` (`integer`, optional): Retrieve pages with the average number of views per day higher than the provided value. Example: 1000.
- `q` (`string`, optional): Primary search query for filtering pages based on their title, summary, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching. Example: "artificial intelligence" AND regulation.
- `size` (`integer`, optional): The number of articles to return per page in the paginated response. Example: 10.
- `sort_by` (`string`, optional): Determines the Wikipedia page sorting order. Options include relevance (default), revisionTsDesc (recently edited first), revisionTsAsc (recently edited last), pageViewsDesc (highest viewership first), pageViewsAsc (highest viewership last), scrapedAtDesc (recently scraped first), scrapedAtAsc (recently scraped last). Example: relevance. One of: `relevance`, `revisionTsDesc`, `revisionTsAsc`, `pageViewsDesc`, `pageViewsAsc`, `scrapedAtDesc`, `scrapedAtAsc`.
- `text` (`string`, optional): Search specifically within the page's content (across all sections). Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations. Example: neural network.
- `title` (`string`, optional): Search specifically within page titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations. Example: earnings.
- `wiki_code` (`array`, optional): Retrieve pages only from specified wiki projects. Currently, the only accepted value is enwiki. Example: enwiki.
- `wikidata_id` (`array`, optional): Retrieve pages by the ids corresponding to their Wikidata entities. Example: Q317521.
- `with_pageviews` (`boolean`, optional): Retrieve pages that have any viewership statistics available for them. If false (the default) - return all pages. Example: true.

Example input: `{}`

### `perigon_wikipedia_vector_search`

Semantic Search Wikipedia · Read-only

Search Wikipedia sections by meaning with a natural-language prompt.
Returns status and results, each with a relevance score and the page section data.
Use perigon_wikipedia_search for keyword search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `prompt` (`string`, required): Natural-language query. Example: What is a large language model?.
- `page` (`integer`, optional): Page number, starting at 0. Example: 0.
- `pageviews_from` (`integer`, optional): Only pages with at least this many views per day. Example: 100.
- `size` (`integer`, optional): Results per page. Example: 10.
- `wiki_revision_from` (`string`, optional): Only pages modified after this date (ISO 8601 or yyyy-mm-dd). Example: 2024-01-01.

Example input: `{"prompt":"<prompt>"}`

### `perigon_x_posts_search`

Search X Posts · Read-only

Search X (Twitter) posts with X search operators.
Returns status, numResults, results (id, url, text, createdAt, author, views, likes, reposts, replies) and nextCursor.
Pass nextCursor as cursor for the next page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `q` (`string`, required): Search query. Supports X search operators, e.g. from:perigon, #ai or "exact phrase". Example: from:perigon #ai.
- `search_type` (`string`, required): Which posts to return: top, latest or media posts. Example: TOP. One of: `TOP`, `LATEST`, `MEDIA`.
- `cursor` (`string`, optional): nextCursor from the previous page. Example: eyJvZmZzZXQiOjIwfQ.

Example input: `{"q":"artificial intelligence","search_type":"TOP"}`

### `perigon_articles_refresh_job_create`

Submit Article Refresh Job · Write

Submit article IDs to refresh their content and metadata in the background.
Returns jobId, status and results with each article's articleId, status and refreshed data when already available.
Poll perigon_articles_refresh_job_get with the job id for the rest. Use perigon_articles_refresh_peek to read only what is already cached.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `article_ids` (`array`, required): articleId values from perigon_articles_search. Example: ["8f1e2d3c4b5a69788776655443322110"]

Example input: `{"article_ids":["8f1e2d3c4b5a69788776655443322110"]}`

### `perigon_contact_point_create`

Create Webhook Contact Point · Write

Create a webhook contact point that receives monitor notifications. Only webhook contact points can be created through the API.
Returns data with the new contact point, including its uuid.
Attach it to monitors with perigon_monitor_create or perigon_monitor_update.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the contact point. Example: Ops webhook.
- `webhook` (`string`, required): HTTPS URL that receives the notifications. Example: https://example.com/hooks/perigon.

Example input: `{"name":"<name>","webhook":"<webhook>"}`

### `perigon_contact_point_update`

Update Contact Point · Write

Rename a contact point, change its webhook URL or its status. Only the fields you send change.
Returns data with the updated contact point.
Use perigon_contact_point_delete to remove it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `uuid` (`string`, required): UUID of the contact point. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.
- `name` (`string`, optional): New name. Example: Ops webhook (prod)
- `status` (`string`, optional): New status. Example: STOPPED. One of: `ACTIVE`, `STOPPED`, `FAILING`, `ARCHIVED`.
- `webhook` (`string`, optional): New webhook URL. Example: https://example.com/hooks/perigon-v2.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_activate`

Activate Monitor · Write

Start or resume a monitor.
Returns data with the monitor.
Use perigon_monitor_pause to stop it temporarily.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_create`

Create Monitor · Write

Create an AI monitor that watches the news for an objective and extracts structured events.
Returns data with the new monitor, including its uuid.
Set status ACTIVE to start it now or DRAFT to start later with perigon_monitor_activate. Attach webhook contact points from perigon_contact_points_list to get notified.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `classification_type` (`string`, required): How matching content is classified: EVENT, MENTIONS or TOPIC. Example: EVENT. One of: `EVENT`, `MENTIONS`, `TOPIC`.
- `data_schema` (`object`, required): Schema of the structured data extracted into each event: a version and a JSON schema. Example: {"version": 1, "schema": {"type": "object", "properties": {"company": {"type": "string"}, "product": {"type": "string"}}}}
- `monitoring_objective` (`string`, required): Plain-language description of what to track, up to 4,096 characters. Example: Detect new product launches by our main competitors.
- `name` (`string`, required): Display name, up to 256 characters. Example: Competitor product launches.
- `query` (`object`, required): Article search filters the monitor evaluates, with the same field names as perigon_articles_search (q, source, country, language, category and so on). Example: {"q": "launch OR unveils", "language": ["en"]}
- `status` (`string`, required): Initial status: ACTIVE or DRAFT. Example: DRAFT. One of: `ACTIVE`, `DRAFT`.
- `contact_point_ids` (`array`, optional): UUIDs of verified contact points that receive notifications. Example: ["3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b"]
- `entity_groups` (`array`, optional): Entity groups to identify, each with a groupReference and description. Example: [{"groupReference": "competitors", "description": "Our main competitors"}]
- `prompt` (`string`, optional): Extra instructions for processing matches, up to 8,192 characters. Example: Ignore rumors and opinion pieces.
- `watchlist_id` (`integer`, optional): Numeric ID of a watchlist to attach, from perigon_watchlists_list. Example: 1234.

Example input: `{"classification_type":"EVENT","data_schema":{},"monitoring_objective":"<monitoring_objective>","name":"<name>","query":{"q":"launch OR unveils","language":["en"]},"status":"ACTIVE"}`

### `perigon_monitor_pause`

Pause Monitor · Write

Pause an active monitor.
Returns data with the monitor.
Use perigon_monitor_activate to resume it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_update`

Update Monitor · Write

Change a monitor's name, objective, query, schema, entity groups or contact points. Only the fields you send change.
Returns data with the updated monitor.
Use perigon_monitor_activate, perigon_monitor_pause or perigon_monitor_archive to change its status.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `uuid` (`string`, required): UUID of the monitor. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.
- `classification_type` (`string`, optional): New classification: EVENT, MENTIONS or TOPIC. Example: EVENT. One of: `EVENT`, `MENTIONS`, `TOPIC`.
- `contact_point_ids` (`array`, optional): Replacement contact point UUIDs; an empty list removes all. Example: ["3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b"]
- `data_schema` (`object`, optional): New extraction schema with version and schema. Example: {"version": 2, "schema": {"type": "object", "properties": {"product": {"type": "string"}}}}
- `entity_groups` (`array`, optional): Replacement entity groups; an empty list removes all. Example: [{"groupReference": "competitors"}]
- `monitoring_objective` (`string`, optional): New plain-language objective. Example: Detect product launches by competitors in Europe.
- `name` (`string`, optional): New display name. Example: Competitor launches (EU)
- `prompt` (`string`, optional): New processing instructions. Example: Only include confirmed launches.
- `query` (`object`, optional): New article search filters. Example: {"q": "launch", "country": ["de", "fr"]}
- `watchlist_id` (`integer`, optional): Numeric ID of a watchlist to attach. Example: 1234.

Example input: `{"uuid":"<uuid>"}`

### `perigon_source_group_create`

Create Source Group · Write

Create a named group of news source domains for filtering searches.
Returns data with the new source group, including its id.
Use its name as source_group in perigon_articles_search.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `domains` (`array`, required): Source domains in the group. Example: ["reuters.com", "apnews.com"]
- `name` (`string`, required): Unique name within your organization. Example: my-trusted-sources.
- `description` (`string`, optional): Description. Example: Wire services we trust.
- `display_name` (`string`, optional): Display name. Example: My trusted sources.

Example input: `{"domains":["reuters.com","apnews.com"],"name":"<name>"}`

### `perigon_source_group_update`

Update Source Group · Write

Update a source group's name, display name, description or domains. Only the fields you send change.
Returns data with the updated source group.
Sending domains replaces the whole list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`integer`, required): Numeric ID of the source group. Example: 1234.
- `description` (`string`, optional): New description. Example: Wire services only.
- `display_name` (`string`, optional): New display name. Example: Trusted wires.
- `domains` (`array`, optional): Replacement list of domains. Example: ["reuters.com", "apnews.com", "afp.com"]
- `name` (`string`, optional): New unique name. Example: trusted-wires.

Example input: `{"id":1234}`

### `perigon_watchlist_create`

Create Watchlist · Write

Create a watchlist of up to 100 people and companies to track in news searches and monitors.
Returns data with the new watchlist, including its id.
Each person or company is an object with a name and optional description, aliases, wikidataId (people) or domain and id (companies), and custom search queries.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `companies` (`array`, required): Companies to track (may be an empty list). Example: [{"name": "Microsoft", "domain": "microsoft.com"}]
- `name` (`string`, required): Unique name within your organization. Example: key-accounts.
- `people` (`array`, required): People to track (may be an empty list). Example: [{"name": "Satya Nadella", "wikidataId": "Q7426870"}]
- `description` (`string`, optional): Description. Example: Top 20 customers.
- `display_name` (`string`, optional): Display name. Example: Key accounts.
- `visible` (`boolean`, optional): Show the watchlist in the Perigon app. Example: true.

Example input: `{"companies":[{"name":"Microsoft","domain":"microsoft.com"}],"name":"<name>","people":[{"name":"Satya Nadella","wikidataId":"Q7426870"}]}`

### `perigon_watchlist_update`

Update Watchlist · Write

Update a watchlist. Only the fields you send change; people and companies replace the existing lists.
Returns data with the updated watchlist.
Keep the combined people and companies at 100 or fewer.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`integer`, required): Numeric ID of the watchlist. Example: 1234.
- `companies` (`array`, optional): Replacement list of companies. Example: [{"name": "Microsoft", "domain": "microsoft.com"}]
- `description` (`string`, optional): New description. Example: Top 25 customers.
- `display_name` (`string`, optional): New display name. Example: Key accounts 2025.
- `name` (`string`, optional): New unique name. Example: key-accounts-2025.
- `people` (`array`, optional): Replacement list of people. Example: [{"name": "Satya Nadella"}]
- `visible` (`boolean`, optional): Show the watchlist in the Perigon app. Example: true.

Example input: `{"id":1234}`

### `perigon_contact_point_delete`

Delete Contact Point · Destructive

Delete a contact point.
Returns data with the deleted contact point.
Monitors stop sending notifications to it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the contact point. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.

Example input: `{"uuid":"<uuid>"}`

### `perigon_monitor_archive`

Archive Monitor · Destructive

Archive (delete) a monitor so it stops running.
Returns data with the archived monitor.
Use perigon_monitor_pause instead to stop it temporarily.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uuid` (`string`, required): UUID of the monitor. Example: 3f1c7b9e-2a4d-4e8f-9b6a-1c2d3e4f5a6b.

Example input: `{"uuid":"<uuid>"}`

### `perigon_source_group_delete`

Delete Source Group · Destructive

Delete a source group.
Returns data with the deleted source group.
Searches that use its name stop matching.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric ID of the source group. Example: 1234.

Example input: `{"id":1234}`

### `perigon_watchlist_delete`

Delete Watchlist · Destructive

Delete a watchlist.
Returns data with the deleted watchlist.
Searches and monitors that use it stop matching its entities.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Numeric ID of the watchlist. Example: 1234.

Example input: `{"id":1234}`

## Related

Other Search connectors ([all 89](/agentkit/connectors/?category=search)):

- [Supadata](/agentkit/connectors/supadata/): Scalekit connector, API key, 21 tools
- [Exa](/agentkit/connectors/exa/): Scalekit connector, API key, 21 tools
- [Brave Search](/agentkit/connectors/brave/): Scalekit connector, API key, 18 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
