Clearout

Learn how to use Clearout with Composio

Overview

SLUG: CLEAROUT

Description

Clearout offers AI-powered email validation, email finder, and prospecting services to enhance email deliverability and lead generation.

Authentication Details

full
stringRequired
generic_api_key
stringRequired

Connecting to Clearout

Create an auth config

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

1

Select App

Navigate to Clearout.

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 Clearout 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
4clearout_auth_config_id = "ac_YOUR_CLEAROUT_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 Clearout 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, clearout_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 Clearout 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=["CLEAROUT"])
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: Autocomplete Company to Domain

Description

Tool to autocomplete company names to probable domains with confidence scores. Use after obtaining a company name or URL to get suggestions.

Action Parameters

query
stringRequired

Action Response

data
arrayRequired
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Business Account Verify

Description

Tool to check if an email belongs to a business/work account. Use when validating corporate emails before onboarding.

Action Parameters

email
stringRequired
timeout
integerDefaults to 90000

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Catch-All Verify

Description

Tool to check if an email domain is catch-all. Use after confirming email validity.

Action Parameters

email
stringRequired
timeout
integerDefaults to 90000

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Verify Disposable Email

Description

Tool to check if an email is from a disposable provider. Use after acquiring an email address.

Action Parameters

email
stringRequired
timeout
integer

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Find Domain MX Records

Description

Tool to retrieve MX records for a domain in priority order. Use when you need to find a domain's mail servers (e.g., for email routing setup).

Action Parameters

domain
stringRequired
timeout
integerDefaults to 90000

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Fetch Domain WHOIS Information

Description

Tool to fetch WHOIS record for a domain. Use when you need WHOIS data for a domain.

Action Parameters

domain
stringRequired
timeout
integerDefaults to 90000

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Bulk Email Finder

Description

Tool to upload a CSV or XLSX contacts file for bulk email finding. Use when you need to find emails for a list of contacts in bulk.

Action Parameters

file
objectRequired
ignore_duplicate_file
stringDefaults to false

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired
validation
object

Tool Name: Cancel Bulk Email Finder Job

Description

Tool to cancel a running bulk email finder job. Use when you need to stop an in-progress list scan before completion.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Bulk Email Finder Result Download

Description

Tool to generate a bulk email finder result download URL. Use after confirming bulk job completion to retrieve the result file link.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Bulk Email Verify

Description

Tool to upload a CSV or XLSX file for bulk email verification. Use when you have a list of emails to verify in bulk.

Action Parameters

file
object
file_mimetype
string
file_name
string
file_path
string
ignore_duplicate_file
stringDefaults to false
optimize
stringDefaults to highest_accuracy

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired
validation
object

Tool Name: Cancel Bulk Email Verification Job

Description

Tool to cancel a running bulk email verification job. Use when you need to stop an in-progress list before completion.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Bulk Email Verify Progress Status

Description

Tool to retrieve progress for a bulk email verification job. Use after initiating a bulk verification to poll its state and percent complete.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Bulk Email Verify Result Download

Description

Tool to obtain a temporary URL for bulk email verification results. Use after completing a bulk verification job to download the results file.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Email Verify Get Credits

Description

Tool to fetch available email verification credits. Use when checking remaining credits before performing email verifications.

Action Parameters

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Instant Email Verifier

Description

Tool to instantly verify a single email address. Use when you need real-time validation before processing an email.

Action Parameters

email
stringRequired
timeout
integer

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Verify Free Email Account

Description

Tool to detect if an email is from a free email service provider. Use after confirming the email format.

Action Parameters

email
stringRequired
timeout
integerDefaults to 90000

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Verify Gibberish Email

Description

Tool to verify if an email address is gibberish. Use when filtering out nonsensical or invalid-looking emails.

Action Parameters

email
stringRequired
timeout
integer

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Reverse Lookup Company by Domain

Description

Tool to find company information by domain. Use when you need to retrieve a company's profile and contact details based on its domain.

Action Parameters

name
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Reverse Lookup Person by Email

Description

Tool to retrieve a person’s profile from an email address. Use when you want to enrich a valid email with associated person details.

Action Parameters

email_address
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Find Person via LinkedIn URL

Description

Tool to discover person information via a LinkedIn profile URL. Use when you need to retrieve person’s profile details from a LinkedIn URL.

Action Parameters

url
stringRequired

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired

Tool Name: Role Account Verifier

Description

Tool to determine if an email is a role-based account. Use when identifying group mailboxes (e.g., support@) before sending targeted communications.

Action Parameters

email
stringRequired
timeout
integer

Action Response

data
object
error
string
status
stringRequired
successful
booleanRequired