Actions41
- Companies Actions
- Search companies
- Search companies (POST)
- Enrich company
- Search companies by name
- Search companies by prompt
- Search similar companies
- Count companies
- Count companies (POST)
- Enrich company by email
- Enrich company by social
- Get email patterns
- Ask company
- Get company context
- Fetch companies analytics
- Export companies analytics
- Lists Actions
- Locations Actions
- Business data Actions
- Actions Actions
- Prompts Actions
- Utilities Actions
Overview
This node integrates with The Companies API to convert a natural language prompt into a segmentation query. It is designed to help users generate targeted company segments based on descriptive prompts, leveraging AI-powered models.
Common scenarios where this node is beneficial include:
- Marketing teams wanting to create precise audience segments from plain-text descriptions.
- Sales teams aiming to identify potential customer groups by describing ideal client profiles.
- Data analysts who need to translate business requirements into structured segmentation criteria.
For example, a user might input a prompt like "tech startups in Europe with less than 50 employees" and receive a structured segmentation that can be used for further analysis or outreach.
Properties
| Name | Meaning |
|---|---|
| Prompt | The natural language text describing the desired segmentation criteria. |
| Model | The AI model size to use for processing the prompt. Options: Small, Large. |
| Context | The context or domain for the segmentation. Options: Analytics, Api, Companies, Company, Documentation, Enrichment, Landing, List, Similarity. |
| Force | A boolean flag to force the operation, potentially overriding default behaviors. |
| List ID | Numeric identifier of a list to associate or filter the segmentation against. |
Output
The node outputs JSON data representing the segmentation result derived from the prompt. This JSON typically contains structured criteria or filters that define the segment of companies matching the prompt description.
If the operation fails or encounters an error, the output JSON will contain an error field with the error message.
No binary data output is produced by this node.
Dependencies
- Requires an API token credential for authenticating with The Companies API.
- Uses The Companies API SDK internally to perform the prompt-to-segmentation conversion.
- No additional environment variables are needed beyond the API token configuration in n8n.
Troubleshooting
- Unknown operation error: If the node throws an error about an unknown operation, ensure the operation parameter is set correctly to "promptToSegmentation".
- SDK method not found: Indicates a mismatch between the requested operation and available SDK methods; verify the node version and SDK compatibility.
- Empty or invalid prompt: Providing an empty prompt may cause the API to return errors or empty results. Always supply a meaningful prompt string.
- API authentication errors: Ensure the API token credential is valid and has sufficient permissions.
- Force flag misuse: Using the force flag incorrectly might lead to unexpected behavior; consult API documentation if unsure.
Links and References
- The Companies API Documentation (general reference for API capabilities)
- n8n Documentation (for configuring credentials and using custom nodes)