Opencage

Learn how to use Opencage with Composio

Overview

SLUG: OPENCAGE

Description

OpenCage Geocoder provides a simple API for forward and reverse geocoding using open data sources.

Authentication Details

generic_key
stringRequired

Connecting to Opencage

Create an auth config

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

1

Select App

Navigate to Opencage.

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 Opencage 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
4opencage_auth_config_id = "ac_YOUR_OPENCAGE_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 Opencage 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, opencage_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 Opencage 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=["OPENCAGE"])
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: Forward Geocode Address

Description

Tool to convert a human-readable address into geographic coordinates. use when you need to retrieve latitude and longitude from an address.

Action Parameters

abbrv
integer
add_request
integer
bounds
string
countrycode
string
language
string
limit
integer
min_confidence
integer
no_annotations
boolean
pretty
boolean
proximity
string
q
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Geocode to GeoJSON

Description

Tool to geocode and return geojson. use when you need geojson featurecollection.

Action Parameters

abbrv
integer
add_request
boolean
address_only
boolean
bounds
string
countrycode
string
language
string
limit
integer
min_confidence
integer
no_annotations
boolean
pretty
boolean
proximity
string
q
stringRequired
roadinfo
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Geocode with JSONP

Description

Tool to perform geocoding and return results in geojsonp format. use when you need a javascript callback wrapped response.

Action Parameters

abbrv
integer
add_request
integer
bounds
string
callback
stringRequired
countrycode
string
jsonp
integer
language
string
limit
integer
min_confidence
integer
no_annotations
integer
no_dedupe
integer
no_record
integer
pretty
integer
proximity
string
q
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reverse Geocode Coordinates

Description

Tool to convert coordinates to a human-readable address. use when you have latitude and longitude and need a readable location.

Action Parameters

abbrv
integer
add_request
integer
countrycode
string
language
string
limit
integerDefaults to 10
min_confidence
integer
no_annotations
integer
normalizecity
integer
pretty
integer
q
stringRequired
roadinfo
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Geocode XML

Description

Tool to perform geocoding and return results in xml format. use when you need xml-formatted geocoding responses from opencage.

Action Parameters

abbrv
integer
add_request
integer
callback
string
countrycode
key
stringRequired
language
string
limit
integerDefaults to 10
min_confidence
integer
no_annotations
integer
no_dedupe
integer
pretty
integer
q
stringRequired
roadinfo
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired