# Perigon

Perigon provides an HTTP REST API for retrieving news and web content data, offering structured data suitable for various applications.

- **Category:** news & lifestyle
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `PERIGON`
- **Version:** 20260312_00

## Tools

### Get News Articles

**Slug:** `PERIGON_GET_ARTICLES`

Tool to retrieve a list of news articles based on filters. Use when keywords, sources, or date ranges are specified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query term or phrase |
| `page` | integer | No | Page number (1-indexed) |
| `sortBy` | string ("relevancy" | "popularity" | "publishedAt") | No | Order to sort articles |
| `country` | string | No | 2-letter country code to filter news sources |
| `domains` | string | No | Comma-separated list of domain names to include |
| `sources` | string | No | Comma-separated list of source IDs |
| `to_date` | string | No | Newest date for articles (YYYY-MM-DD or ISO8601) |
| `category` | string | No | Article category, e.g., technology, sports |
| `language` | string | No | 2-letter language code, e.g., 'en' |
| `pageSize` | integer | No | Number of results per page (1-100) |
| `from_date` | string | No | Oldest date for articles (YYYY-MM-DD or ISO8601) |
| `excludeDomains` | string | No | Comma-separated list of domain names to exclude |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Companies

**Slug:** `PERIGON_GET_COMPANIES`

Tool to retrieve information on companies in Perigon’s entity database. Use when you need a full list of companies. Use after confirming a valid API key is present.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Journalists

**Slug:** `PERIGON_GET_JOURNALISTS`

Tool to retrieve journalist profiles including title, Twitter handle, bio, and location. Use when you need detailed journalist info to enrich content with author metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to return (default: 10, max: 100) |
| `query` | string | No | Search string for journalist name |
| `offset` | integer | No | Number of items to skip for pagination |
| `outlet` | string | No | Filter journalists by outlet name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Media Sources

**Slug:** `PERIGON_GET_SOURCES`

Tool to retrieve a list of media sources with filtering options. Use when you need to list sources by domain, country, category, or traffic metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1) |
| `domain` | string | No | Filter by domain of the source (e.g., cnn.com) |
| `country` | string | No | Filter by country code (ISO-3166-1 alpha-2, e.g., US) |
| `category` | string ("general" | "sports" | "technology" | "business" | "entertainment" | "health" | "science") | No | Filter by category of the source |
| `language` | string | No | Filter by language code (ISO-639-1, e.g., en) |
| `per_page` | integer | No | Results per page (default: 10, max: 100) |
| `max_stories` | integer | No | Filter for sources with maximum stories per month |
| `max_traffic` | integer | No | Filter for sources with a maximum SimilarWeb global rank |
| `min_stories` | integer | No | Filter for sources with minimum stories per month |
| `min_traffic` | integer | No | Filter for sources with a minimum SimilarWeb global rank |
| `exclude_domains` | string | No | Comma-separated list of domains to exclude |
| `include_domains` | string | No | Comma-separated list of domains to include |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stories

**Slug:** `PERIGON_GET_STORIES`

Tool to retrieve clusters of related articles covering the same event or topic with aggregate metrics. Use when you need to fetch filtered and sorted story clusters after configuring query parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query keywords or phrases |
| `ids` | string | No | Comma-separated story IDs |
| `page` | integer | No | Page number for pagination |
| `type` | string | No | Story type, e.g., 'story', 'opinion', 'analysis' |
| `image` | boolean | No | Only stories with images |
| `video` | boolean | No | Only stories with videos |
| `domain` | string | No | Comma-separated domains to filter by |
| `sortBy` | string | No | Sort method for story results (default: createdAt) |
| `cluster` | integer | No | Only show stories in a given cluster |
| `country` | string | No | Country code, e.g., 'us' |
| `not_ids` | string | No | Exclude comma-separated story IDs |
| `paywall` | boolean | No | Only paywalled or non-paywalled content |
| `sources` | string | No | Comma-separated source IDs to filter by |
| `to_date` | string | No | End date for filtering stories in ISO 8601 format |
| `category` | string | No | News category, e.g., 'sports' |
| `language` | string | No | Language code, e.g., 'en' |
| `from_date` | string | No | Start date for filtering stories in ISO 8601 format |
| `max_score` | number | No | Maximum Perigon story score |
| `min_score` | number | No | Minimum Perigon story score |
| `sentiment` | string ("positive" | "neutral" | "negative") | No | Filter by sentiment |
| `cluster_min_score` | number | No | Minimum clustering score |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Topics

**Slug:** `PERIGON_GET_TOPICS`

Tool to retrieve all available Perigon news topics. Returns a list of topics that can be used to filter articles or stories. Each topic includes an ID, name, and labels (category/subcategory).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Wikipedia Articles

**Slug:** `PERIGON_GET_WIKIPEDIA`

Tool to search and filter Wikipedia pages. Use when you have a search query ready and want to retrieve relevant Wikipedia articles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search query for the Wikipedia articles |
| `page` | integer | No | Page number for pagination (default: 1) |
| `size` | integer | No | Number of results per page (default: 10, maximum: 100) |
| `language` | string | No | Two-letter Wikipedia language code (e.g., 'en', 'es') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Vector Search Articles

**Slug:** `PERIGON_VECTOR_SEARCH_ARTICLES`

Tool to perform a vector search on Perigon’s real-time news database. Use when you need to retrieve semantically similar news articles given a natural language query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Natural language search text to vectorize and find similar articles |
| `top_k` | integer | No | Number of top results to return, must be >=1 |
| `filter` | object | No | Optional filters to narrow down results (source, category, language) |
| `vector_options` | object | No | Advanced vector search options like model override |
| `include_vectors` | boolean | No | Whether to include article vectors in response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Vector Search Wikipedia

**Slug:** `PERIGON_VECTOR_SEARCH_WIKIPEDIA`

Tool to perform semantic retrieval of Wikipedia pages using vector search. Use after obtaining a search query to find relevant Wikipedia articles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return (default: 10) |
| `query` | string | Yes | Search query for Wikipedia pages |
| `include_context` | boolean | No | Whether to include context passages in the response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |