NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Gender API connects to a Nagent workspace with an API key. Once it is connected, agents can call 9 Gender API actions, such as "Get Country of Origin", "Get Country of Origin (v1)" and "Get Gender API 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 Gender API, with input parameters and output schema.
GENDER_API_GET_COUNTRY_OF_ORIGINTool to retrieve a name's likely countries of origin. Use after confirming the name identifier.
Input parameters
Client-defined request ID for correlation (max 50 chars).
Email address to query; can be provided instead of first_name.
Full name to query; can be provided instead of first_name.
First name to query. Required if full_name and email are not provided.
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
GENDER_API_GET_COUNTRY_OF_ORIGIN_V1Tool to get the country of origin for a given first name using v1 API. Returns the most likely country where the name is most common.
Input parameters
First name to query country of origin for. Must contain at least one non-space character.
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
GENDER_API_GET_STATISTICTool 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.
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
GENDER_API_QUERY_BY_EMAIL_ADDRESSDetermine likely gender from an email address by extracting and analyzing the name portion. Returns male/female/unknown with a confidence score. Optionally filter by country for improved accuracy. Check result_found to know if a determination was made; probability indicates confidence level.
Input parameters
Client-provided correlation ID
Valid IPv4 or IPv6 address
Email address to query for gender determination
Browser locale code (e.g., 'en_US')
ISO 3166 ALPHA-2 country code
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
GENDER_API_QUERY_BY_EMAIL_ADDRESS_MULTIPLEDetermine likely gender for multiple email addresses in a single batch request. Returns male/female/unknown with confidence scores for each email. Use for efficient bulk processing. Each result includes result_found flag and optional probability score.
Input parameters
List of email queries to process in a single batch request
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
GENDER_API_QUERY_BY_FIRST_NAMETool to determine the gender of a first name. Use when you need to identify gender based on a given name.
Input parameters
Client-defined correlation ID, max 50 characters.
Valid IPv4 or IPv6 address.
Browser locale, e.g., 'en-US'.
ISO 3166 ALPHA-2 country code.
Name to query.
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
GENDER_API_QUERY_BY_FULL_NAMETool 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.
Input parameters
Arbitrary ID (max 50 chars) for correlating batch responses.
Valid IPv4 or IPv6 address for geo-based gender inference.
Browser locale string (e.g., en_US) for more accurate inference.
ISO 3166 alpha-2 country code to hint regional gender conventions.
Full name to query; must contain at least one non-space character.
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
GENDER_API_QUERY_GENDER_BY_FIRST_NAME_MULTIPLETool to determine gender for multiple first names in a single batch request. Use when you need to query gender for several names efficiently to save API credits and reduce latency.
Input parameters
List of name queries to process in a single batch request.
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
GENDER_API_QUERY_GENDER_BY_FULL_NAME_MULTIPLETool to batch query gender for multiple full names in a single request. Use when you need to determine gender for multiple names efficiently. Each name can optionally include country, locale, or IP for more accurate regional inference.
Input parameters
List of name query items to process in a single batch request.
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 9 Gender API actions on Nagent, including "Get Country of Origin", "Get Country of Origin (v1)" and "Get Gender API Statistics". Get Country of Origin: Retrieve a name's likely countries of origin. Each action is listed on this page with its input parameters and its output.
Gender API 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.
It also takes 4 optional inputs: id, email, full_name and first_name. It returns data, error and successful.