Perigon

Learn how to use Perigon with Composio

Overview

SLUG: PERIGON

Description

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

Authentication Details

generic_api_key
stringRequired

Connecting to Perigon

Create an auth config

Use the dashboard to create an auth config for the Perigon toolkit. This allows you to connect multiple Perigon accounts to Composio for agents to use.

1

Select App

Navigate to Perigon.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Perigon Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4perigon_auth_config_id = "ac_YOUR_PERIGON_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Perigon for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, perigon_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Perigon toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PERIGON"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get News Articles

Description

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

Action Parameters

category
string
country
string
domains
string
excludeDomains
string
from_date
string
language
string
page
integer
pageSize
integer
q
string
sortBy
string
sources
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Companies

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Journalists

Description

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.

Action Parameters

limit
integer
offset
integer
outlet
string
query
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Media Sources

Description

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.

Action Parameters

category
string
country
string
domain
string
exclude_domains
string
include_domains
string
language
string
max_stories
integer
max_traffic
integer
min_stories
integer
min_traffic
integer
page
integerDefaults to 1
per_page
integerDefaults to 10

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Stories

Description

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.

Action Parameters

category
string
cluster
integer
cluster_min_score
number
country
string
domain
string
from_date
string
ids
string
image
boolean
language
string
max_score
number
min_score
number
not_ids
string
page
integerDefaults to 1
paywall
boolean
q
string
sentiment
string
sortBy
string
sources
string
to_date
string
type
string
video
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Topics

Description

Tool to retrieve available perigon news topics using contextual intelligence. use after authenticating and when exploring article topics.

Action Parameters

q
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Wikipedia Articles

Description

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

Action Parameters

language
string
page
integerDefaults to 1
q
stringRequired
size
integerDefaults to 10

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Vector Search Articles

Description

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.

Action Parameters

filter
object
include_vectors
boolean
query
stringRequired
top_k
integerDefaults to 10
vector_options
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Vector Search Wikipedia

Description

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

Action Parameters

include_context
boolean
limit
integerDefaults to 10
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired