The Companies API icon

The Companies API

Access company data, enrichment, analytics and more using The Companies API

Overview

This node integrates with The Companies API to generate product-related prompts based on user input. Specifically, the "Product prompt" operation allows users to send a textual prompt along with various contextual parameters to receive enriched or processed product information from the API.

Common scenarios where this node is beneficial include:

  • Generating detailed product descriptions or insights based on a short prompt.
  • Enriching product data by leveraging different contexts such as analytics, company data, or documentation.
  • Automating content creation workflows that require AI-enhanced product information.
  • Integrating product intelligence into marketing, sales, or research pipelines.

For example, a user might input a brief product idea or feature request and receive a comprehensive product prompt response tailored by the selected model size and context.

Properties

Name Meaning
Prompt The main text prompt describing the product or query to be processed.
Model The size of the model used for processing: either "Small" or "Large".
Context The domain context influencing the prompt generation. Options: Analytics, Api, Companies, Company, Documentation, Enrichment, Landing, List, Similarity.
Feature The specific feature or action related to the prompt. Options: Ask, Cleanup, Enrich, Product, Search, Similar.
Force A boolean flag indicating whether to force the operation regardless of caching or other conditions.
List ID Numeric identifier for a list, if applicable to the prompt context.
Company ID Numeric identifier for a company, if relevant to the prompt.

Output

The node outputs JSON data containing the response from The Companies API's productPrompt method. The structure typically includes:

  • json: An object with the API response data related to the generated product prompt.
  • pairedItem: Metadata linking the output item to the corresponding input item index.

No binary data output is produced by this node.

Dependencies

  • Requires an API token credential for authenticating with The Companies API.
  • Uses the official SDK from @thecompaniesapi/sdk.
  • The node expects the API token to be configured in n8n credentials under a generic API key/token type.

Troubleshooting

  • Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error stating "Unknown operation". Ensure the operation is set exactly to "productPrompt".
  • SDK method not found: If the SDK does not have the expected method, it will throw an error like "SDK method productPrompt not found". This may indicate an outdated SDK version or misconfiguration.
  • Empty or invalid parameters: Parameters that are empty strings, zero, or null are filtered out before sending. If required parameters are missing, the API may return errors or incomplete data.
  • API authentication failures: Ensure the API token credential is valid and has sufficient permissions.
  • Continue on fail: If enabled, the node will output error messages per item instead of stopping execution.

Links and References

Discussion