Gender api

Learn how to use Gender api with Composio

Overview

SLUG: GENDER_API

Description

Gender API determines the gender of a first name, email address, or username.

Authentication Details

generic_api_key
stringRequired

Connecting to Gender api

Create an auth config

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

1

Select App

Navigate to [Gender api](https://platform.composio.dev?next_page=/marketplace/Gender api).

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 Gender api 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
4gender_api_auth_config_id = "ac_YOUR_GENDER_API_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 Gender api 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, gender_api_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 [Gender api toolkit’s playground](https://app.composio.dev/app/Gender api)

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=["GENDER_API"])
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 Country of Origin

Description

Tool to retrieve a name's likely countries of origin. Use after confirming the name identifier.

Action Parameters

email
string
first_name
string
full_name
string
id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Gender API Statistics

Description

Tool to retrieve account statistics from Gender-API, including remaining credits and usage details. Use when you need to check your credit balance before performing further gender lookups.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query Gender by Email Address

Description

Tool to determine gender from an email address. Use when you need the likely gender based on an email.

Action Parameters

country
string
email
stringRequired
id
string
ip
string
locale
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Gender From First Name

Description

Tool to determine the gender of a first name. Use when you need to identify gender based on a given name.

Action Parameters

country
string
first_name
stringRequired
id
string
ip
string
locale
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query Gender by Full Name

Description

Tool to determine gender by splitting a full name. Use when you have an exact full name string and want to infer gender. Slightly less reliable for rare or ambiguous names.

Action Parameters

country
string
full_name
stringRequired
id
string
ip
string
locale
string

Action Response

data
objectRequired
error
string
successful
booleanRequired