NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Headout connects to a Nagent workspace with an API key. Once it is connected, agents can call 8 Headout actions, such as "Get Product By ID", "List Categories V2" and "List Cities". 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 Headout, with input parameters and output schema.
HEADOUT_GET_PRODUCT_BY_IDTool to retrieve detailed product information by product ID. Use when you need comprehensive product details including pricing, images, location, variants, and availability.
Input parameters
Language code for product details (defaults to EN). Supported languages include EN, ES, FR, IT, DE, PT, NL, etc.
The unique identifier for the product to retrieve.
Currency code for pricing in ISO 4217 format (e.g., USD, EUR, GBP, AED). If not specified, default currency will be used.
Controls whether to include variant data in the response. Defaults to true if not specified.
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
HEADOUT_LIST_CATEGORIES_V2Tool to fetch all available activity categories for a specific city using V2 API. Use when you need to list categories of activities available in a particular city location.
Input parameters
The city code to fetch categories for (e.g., 'NEW_YORK', 'LONDON').
Language code for the response. Defaults to 'EN' if 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
HEADOUT_LIST_CITIESTool to list all active cities with pagination support. Use when you need to retrieve available cities from the Headout platform. Supports pagination through offset and limit parameters.
Input parameters
Maximum number of results to return. Used for pagination purposes.
Starting point for retrieving results. Used for pagination purposes.
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
HEADOUT_LIST_COLLECTIONS_V2Tool to fetch all collections for a specific city using V2 API with pagination support. Use when you need to browse collections available in a particular city, with optional language-specific content and pagination controls.
Input parameters
Limit for pagination. Defaults to 10 if not provided. Specifies the maximum number of collections to return.
Offset for pagination. Defaults to 0 if not provided.
The city code to fetch collections for (e.g., 'DUBAI', 'LONDON', 'NEW_YORK').
Language code for localized content. Defaults to 'EN' if 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
HEADOUT_LIST_INVENTORY_BY_VARIANTTool to retrieve available inventory and pricing for a specific product variant. Use when you need to check availability and pricing details for booking.
Input parameters
Maximum number of records to return per page.
Pagination offset for result set navigation.
The identifier for the product variant needing inventory lookup.
End date-time for inventory query in fm-date-time format; treated as unlimited if not provided.
Three-letter currency code for pricing presentation (e.g., USD, AED) per ISO 4217 standard.
Start date-time for inventory query in fm-date-time format; defaults to current timestamp if omitted.
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
HEADOUT_LIST_PRODUCTS_BY_CATEGORYTool to list product listings filtered by category ID with pagination support. Use when you need to retrieve products for a specific category.
Input parameters
Number of results to return per request. Controls pagination.
Offset value for pagination. Use to retrieve next set of results.
Language code for the response. Supported languages include EN, ES, FR, IT, DE, PT, NL. Defaults to EN.
The ID of the category to filter products by.
Currency code following ISO 4217 standard (e.g., USD, EUR, AED).
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
HEADOUT_LIST_PRODUCTS_V2Tool to fetch products using Headout V2 API with filtering by city, collection, category, or subcategory. Use when you need to retrieve product listings for specific locations or categories with pagination support.
Input parameters
Pagination limit - maximum number of products to return. Defaults to 20.
Pagination offset - the number of items to skip. Defaults to 0.
The city code for product filtering. Required parameter to fetch products for a specific city.
Optional category identifier to filter products by category.
Optional campaign name for filtering products by marketing campaign.
Optional collection identifier to filter products by collection.
Currency code for pricing display.
Language preference for product content. Defaults to EN if not specified.
Optional subcategory identifier to filter products by subcategory.
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
HEADOUT_LIST_SUBCATEGORIES_V2Tool to fetch all subcategories for a specific city using V2 API. Use when you need to list subcategories of activities available in a particular city location.
Input parameters
The city code to fetch subcategories for (e.g., 'NEW_YORK', 'LONDON', 'PARIS').
Language code for the response. Defaults to 'EN' if 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
Agents can call 8 Headout actions on Nagent, including "Get Product By ID", "List Categories V2" and "List Cities". Get Product By ID: Retrieve detailed product information by product ID. Each action is listed on this page with its input parameters and its output.
Headout 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 Product By ID takes 1 required input: product_id. It also takes 3 optional inputs: language, currencyCode and fetch-variants. It returns data, error and successful.