NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
GenderAPI.io connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 GenderAPI.io actions, such as "Get Gender from Username", "List Gender API Error Codes" and "Gender API Get Statistics". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against GenderAPI.io, with input parameters and output schema.
GENDERAPI_IO_GENDERAPI_GET_STATSTool to retrieve account usage statistics from GenderAPI.io. Use when you need to check remaining API credits and expiry.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GENDERAPI_IO_GENDER_API_QUERY_BY_FIRST_NAMETool to determine gender by querying first name. Use when you need to infer likely gender for a given name with optional localization hints.
Input parameters
Optional arbitrary identifier (up to 50 characters) to correlate the response.
Optional IP address (IPv4 or IPv6) to localize the query.
First name to query gender for.
Optional locale to guide gender inference.
Ask AI model when the name isn’t present in the database.
Optional ISO 3166 alpha-2 country code to localize the query.
Attempt to genderize even for non-typical names (e.g., nicknames).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GENDERAPI_IO_GET_GENDER_FROM_USERNAMETool to determine gender from a username or nickname. Use when you have an alias or handle and want to infer gender from that identifier.
Input parameters
If true, asks the AI model when the name is not found in the database.
Optional ISO 3166-1 alpha-2 country code to improve prediction accuracy.
Username or nickname to analyze for gender inference.
If true, attempts prediction even for usernames that don't resemble real names.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GENDERAPI_IO_LIST_ERROR_CODESTool to list all possible error codes returned by Gender API. Use when debugging or validating API responses.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GENDERAPI_IO_QUERY_BY_EMAIL_ADDRESSTool to determine gender from an email address. Use when you need to infer gender for personalization after obtaining proper consent.
Input parameters
Optional client-provided ID (max 50 characters) for tracing.
Valid IPv4 or IPv6 address for geo-hinting.
Email address to query; must be a valid email format.
Browser locale to improve name parsing (e.g., 'en', 'fr').
ISO 3166-1 alpha-2 country code to hint the endpoint (uppercase).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 5 GenderAPI.io actions on Nagent, including "Get Gender from Username", "List Gender API Error Codes" and "Gender API Get Statistics". Get Gender from Username: Determine gender from a username or nickname. Each action is listed on this page with its input parameters and its output.
GenderAPI.io connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Gender from Username takes 1 required input: username. It also takes 3 optional inputs: askToAI, country and forceToGenderize. It returns data, error and successful.