Perigon integration (AI, Data). Imported from open-connector.
https://api.perigon.io/v1/articles/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The primary search query using Perigon Boolean search syntax. |
| title | string | optional | A search query scoped to article titles. |
| desc | string | optional | A search query scoped to article descriptions. |
| content | string | optional | A search query scoped to article content. |
| summary | string | optional | A search query scoped to article summaries. |
| from | string | optional | The earliest publication date or date-time to include. |
| to | string | optional | The latest publication date or date-time to include. |
| addDateFrom | string | optional | The earliest Perigon ingestion date or date-time to include. |
| addDateTo | string | optional | The latest Perigon ingestion date or date-time to include. |
| category | array | optional | The broad news categories to include. |
| topic | array | optional | The Perigon topics to include. |
| source | array | optional | The publisher domains or wildcard source patterns to include. |
| sourceGroup | array | optional | The curated Perigon source groups to include. |
| language | array | optional | The ISO 639 language codes to include. |
| country | array | optional | The source country codes to include. |
| label | array | optional | The editorial labels to include. |
| medium | array | optional | The article media types to include. |
| personName | array | optional | The exact person names to include. |
| personWikidataId | array | optional | The Wikidata person IDs to include. |
| companyName | string | optional | The exact company name to include. |
| companyDomain | array | optional | The company domains to include. |
| companyId | array | optional | The Perigon company IDs to include. |
| companySymbol | array | optional | The company stock symbols to include. |
| journalistId | array | optional | The journalist IDs to include. |
| author | array | optional | The author names to include. |
| clusterId | array | optional | The story cluster IDs to include. |
| showReprints | boolean | optional | Whether wire-service reprints should be included. |
| sortBy | string | optional | The article sort order. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
/v1/stories/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The primary search query using Perigon Boolean search syntax. |
| title | string | optional | A search query scoped to article titles. |
| desc | string | optional | A search query scoped to article descriptions. |
| content | string | optional | A search query scoped to article content. |
| summary | string | optional | A search query scoped to article summaries. |
| from | string | optional | The earliest publication date or date-time to include. |
| to | string | optional | The latest publication date or date-time to include. |
| addDateFrom | string | optional | The earliest Perigon ingestion date or date-time to include. |
| addDateTo | string | optional | The latest Perigon ingestion date or date-time to include. |
| category | array | optional | The broad news categories to include. |
| topic | array | optional | The Perigon topics to include. |
| source | array | optional | The publisher domains or wildcard source patterns to include. |
| sourceGroup | array | optional | The curated Perigon source groups to include. |
| language | array | optional | The ISO 639 language codes to include. |
| country | array | optional | The source country codes to include. |
| label | array | optional | The editorial labels to include. |
| medium | array | optional | The article media types to include. |
| personName | array | optional | The exact person names to include. |
| personWikidataId | array | optional | The Wikidata person IDs to include. |
| companyName | string | optional | The exact company name to include. |
| companyDomain | array | optional | The company domains to include. |
| companyId | array | optional | The Perigon company IDs to include. |
| companySymbol | array | optional | The company stock symbols to include. |
| journalistId | array | optional | The journalist IDs to include. |
| author | array | optional | The author names to include. |
| clusterId | array | optional | The story cluster IDs to include. |
| showReprints | boolean | optional | Whether wire-service reprints should be included. |
| sortBy | string | optional | The story sort order. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
| name | string | optional | A search query scoped to story names. |
| initializedFrom | string | optional | The earliest story initialization date or date-time to include. |
| initializedTo | string | optional | The latest story initialization date or date-time to include. |
| updatedFrom | string | optional | The earliest story update date or date-time to include. |
| updatedTo | string | optional | The latest story update date or date-time to include. |
| minUniqueSources | integer | optional | The minimum number of unique sources in a story. |
| minSourceDiversity | number | optional | The minimum unique-source to unique-article ratio. |
/v1/sources/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The source search query. |
| name | string | optional | A search query scoped to source names or aliases. |
| sourceGroup | string | optional | The curated Perigon source group to include. |
| domain | array | optional | The exact source domains to include. |
| paywall | boolean | optional | Whether to filter sources by paywall status. |
| minMonthlyPosts | integer | optional | The minimum monthly article count. |
| maxMonthlyPosts | integer | optional | The maximum monthly article count. |
| minMonthlyVisits | integer | optional | The minimum monthly visit count. |
| maxMonthlyVisits | integer | optional | The maximum monthly visit count. |
| showSubdomains | boolean | optional | Whether subdomains should be returned as separate sources. |
| sourceLat | number | optional | The latitude used for source geo search. |
| sourceLon | number | optional | The longitude used for source geo search. |
| sourceMaxDistance | number | optional | The source geo-search radius in kilometers. |
| sortBy | string | optional | The source sort order. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
/v1/topics/all
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The topic name filter. |
| category | string | optional | The parent category filter. |
| subcategory | string | optional | The subcategory filter. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
/v1/journalists/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The journalist search query. |
| name | string | optional | A search query scoped to journalist names. |
| string | optional | The exact Twitter or X handle without the at sign. | |
| minMonthlyPosts | integer | optional | The minimum monthly article count. |
| maxMonthlyPosts | integer | optional | The maximum monthly article count. |
| updatedAtFrom | string | optional | The earliest journalist profile update date or date-time. |
| updatedAtTo | string | optional | The latest journalist profile update date or date-time. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
/v1/journalists/{id}
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | required | The Perigon journalist ID. |
/v1/people/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The person search query. |
| name | string | optional | A search query scoped to person names. |
| wikidataId | array | optional | The Wikidata person IDs to include. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
/v1/companies/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The company search query. |
| name | string | optional | A search query scoped to company names. |
| domain | array | optional | The company domains to include. |
| symbol | array | optional | The stock symbols to include. |
| id | array | optional | The Perigon company IDs to include. |
| industry | string | optional | The company industry filter. |
| sector | string | optional | The company sector filter. |
| country | array | optional | The company country codes to include. |
| exchange | string | optional | The stock exchange filter. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
/v1/wikipedia/all
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The Wikipedia search query. |
| title | string | optional | A search query scoped to Wikipedia page titles. |
| summary | string | optional | A search query scoped to Wikipedia summaries. |
| text | string | optional | A search query scoped to Wikipedia page text. |
| reference | string | optional | A search query scoped to Wikipedia page references. |
| scrapedAtFrom | string | optional | The earliest Perigon scrape date or date-time to include. |
| scrapedAtTo | string | optional | The latest Perigon scrape date or date-time to include. |
| wikiRevisionFrom | string | optional | The earliest Wikipedia revision date or date-time to include. |
| wikiRevisionTo | string | optional | The latest Wikipedia revision date or date-time to include. |
| pageviewsFrom | integer | optional | The minimum average daily pageview count. |
| pageviewsTo | integer | optional | The maximum average daily pageview count. |
| withPageviews | boolean | optional | Whether only pages with pageview data should be returned. |
| id | array | optional | The Perigon Wikipedia page IDs to include. |
| sectionId | array | optional | The Wikipedia section IDs to include. |
| category | array | optional | The Wikipedia categories to include. |
| wikiCode | array | optional | The wiki project codes to include. |
| wikidataId | array | optional | The Wikidata IDs to include. |
| wikidataInstanceOfId | array | optional | The Wikidata instance-of IDs to include. |
| wikidataInstanceOfLabel | array | optional | The Wikidata instance-of labels to include. |
| wikiNamespace | array | optional | The Wikipedia namespaces to include. |
| wikiPageId | array | optional | The Wikipedia page IDs to include. |
| wikiRevisionId | array | optional | The Wikipedia revision IDs to include. |
| sortBy | string | optional | The Wikipedia sort order. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
/v1/summarize
| Param | Type | Required | Description |
|---|---|---|---|
| q | string | optional | The primary search query using Perigon Boolean search syntax. |
| title | string | optional | A search query scoped to article titles. |
| desc | string | optional | A search query scoped to article descriptions. |
| content | string | optional | A search query scoped to article content. |
| summary | string | optional | A search query scoped to article summaries. |
| from | string | optional | The earliest publication date or date-time to include. |
| to | string | optional | The latest publication date or date-time to include. |
| addDateFrom | string | optional | The earliest Perigon ingestion date or date-time to include. |
| addDateTo | string | optional | The latest Perigon ingestion date or date-time to include. |
| category | array | optional | The broad news categories to include. |
| topic | array | optional | The Perigon topics to include. |
| source | array | optional | The publisher domains or wildcard source patterns to include. |
| sourceGroup | array | optional | The curated Perigon source groups to include. |
| language | array | optional | The ISO 639 language codes to include. |
| country | array | optional | The source country codes to include. |
| label | array | optional | The editorial labels to include. |
| medium | array | optional | The article media types to include. |
| personName | array | optional | The exact person names to include. |
| personWikidataId | array | optional | The Wikidata person IDs to include. |
| companyName | string | optional | The exact company name to include. |
| companyDomain | array | optional | The company domains to include. |
| companyId | array | optional | The Perigon company IDs to include. |
| companySymbol | array | optional | The company stock symbols to include. |
| journalistId | array | optional | The journalist IDs to include. |
| author | array | optional | The author names to include. |
| clusterId | array | optional | The story cluster IDs to include. |
| showReprints | boolean | optional | Whether wire-service reprints should be included. |
| sortBy | string | optional | The article sort order. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| showNumResults | boolean | optional | Whether Perigon should return an exact result count. |
| prompt | string | optional | Instructions guiding the generated summary. |
| maxArticleCount | integer | optional | The maximum number of matching articles to summarize. |
| returnedArticleCount | integer | optional | The maximum number of source articles to return. |
| maxTokens | integer | optional | The maximum generated-token budget for the summary. |
| temperature | number | optional | The model sampling temperature. |
| topP | number | optional | The nucleus sampling value. |
| model | string | optional | The Perigon-supported language model to use. |
| method | string | optional | The article selection method. |
| summarizeFields | array | optional | The article fields Perigon should include in the summarization context. |
/v1/vector/news/all
| Param | Type | Required | Description |
|---|---|---|---|
| prompt | string | required | The natural-language prompt for semantic news search. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| pubDateFrom | string | optional | The earliest article publication date or date-time to include. |
| pubDateTo | string | optional | The latest article publication date or date-time to include. |
| showReprints | boolean | optional | Whether wire-service reprints should be included. |
| filter | object | optional | A Perigon vector-search filter object with direct fields or nested AND, OR, and… |
/v1/vector/wikipedia/all
| Param | Type | Required | Description |
|---|---|---|---|
| prompt | string | required | The natural-language prompt for semantic Wikipedia search. |
| page | integer | optional | The zero-based page number to retrieve. |
| size | integer | optional | The number of results to return per page. |
| pageviewsFrom | integer | optional | The minimum average daily pageview count. |
| pageviewsTo | integer | optional | The maximum average daily pageview count. |
| wikiRevisionFrom | string | optional | The earliest Wikipedia revision date or date-time to include. |
| wikiRevisionTo | string | optional | The latest Wikipedia revision date or date-time to include. |
| filter | object | optional | A Perigon vector-search filter object with direct fields or nested AND, OR, and… |