Agentql

Learn how to use Agentql with Composio

Overview

SLUG: AGENTQL

Description

AgentQL is a suite of tools designed to connect AI agents to the web, enabling web interaction and structured data extraction through a specialized query language.

Authentication Details

generic_api_key
stringRequired

Connecting to Agentql

Create an auth config

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

1

Select App

Navigate to the Agentql toolkit page and click “Setup Integration”.

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

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Agentql 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=["AGENTQL"])
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: Query Data

Description

Tool to query structured data as json from a web page using an agentql query or natural language prompt. use after defining your query or prompt and a url or html.

Action Parameters

html
string
params
object
prompt
string
query
string
url
string

Action Response

data
objectRequired
error
string
metadata
objectRequired
successful
booleanRequired

Tool Name: Create Remote Browser Session

Description

Tool to create a remote browser session. use when you need to run browser automation on remote infrastructure.

Action Parameters

browser_ua_preset
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Usage Details

Description

Tool to retrieve subscription usage details for the current api key, including usage limits and billing period. use after confirming api connection is valid.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired