Fire-Enrich API完全手册：如何集成智能数据增强能力到你的应用-程序员充电站

Fire-Enrich API完全手册：如何集成智能数据增强能力到你的应用

【免费下载链接】fire-enrich🔥 AI-powered data enrichment tool that transforms emails into rich datasets with company profiles, funding data, tech stacks, and more using Firecrawl and multi-agent AI项目地址: https://gitcode.com/gh_mirrors/fi/fire-enrich

Fire-Enrich是一款基于AI的智能数据增强工具，它能够将电子邮件转换为包含公司概况、融资数据、技术栈等丰富信息的数据集。本手册将详细介绍如何通过Fire-Enrich API将这些强大的智能数据增强能力集成到你的应用中，帮助你轻松获取和处理有价值的商业信息。

快速了解Fire-Enrich API

Fire-Enrich API是连接你的应用与Fire-Enrich智能数据增强功能的桥梁。通过调用一系列API端点，你可以实现数据的抓取、生成、丰富和交互等操作，为你的应用增添强大的智能数据处理能力。

API端点概览

Fire-Enrich提供了多个功能丰富的API端点，满足不同的数据处理需求：

/api/check-env：使用GET方法，用于检查环境变量配置情况，确保API密钥等必要配置已正确设置。
/api/chat：采用POST方法，提供聊天交互功能，可基于表格数据或网络搜索回答相关问题。
/api/generate-fields：通过POST方法，根据用户输入生成字段定义，为数据处理提供结构化支持。
/api/scrape：使用POST方法，用于从指定来源抓取数据，是数据获取的重要入口。
/api/enrich：采用POST方法，对数据进行增强处理，添加公司概况、融资数据等丰富信息。

API密钥配置与管理

使用Fire-Enrich API需要正确配置相关的API密钥，以确保服务的正常调用和数据安全。

必要的API密钥

Fire-Enrich API主要依赖以下几种API密钥：

OPENAI_API_KEY：用于调用OpenAI的服务，实现AI相关的功能。
FIRECRAWL_API_KEY：用于使用Firecrawl的服务，支持数据的抓取等操作。
ANTHROPIC_API_KEY：Anthropic相关服务的密钥（可选）。

你可以通过环境变量设置这些API密钥，也可以在请求头中通过X-OpenAI-API-Key和X-Firecrawl-API-Key等方式传递。

检查API密钥配置

你可以通过调用/api/check-env端点来检查API密钥的配置情况，该端点会返回各密钥的配置状态，帮助你确认是否已正确设置所需的密钥。

核心API端点使用指南

数据抓取：/api/scrape

功能：从指定来源抓取数据，为后续的数据处理提供原始素材。

请求格式：使用POST方法，请求体需符合特定的格式要求。如果请求格式无效，API会返回Invalid request format. Please check your input and try again.的错误提示。

使用示例：

POST /api/scrape { "url": "https://example.com" }

字段生成：/api/generate-fields

功能：根据用户输入生成字段定义，帮助你构建结构化的数据模型。

请求与响应：采用POST方法，其响应格式基于Zod模式，会返回包含字段定义数组的结果。相关的类型定义可参考lib/types/field-generation.ts。

数据增强：/api/enrich

功能：这是Fire-Enrich的核心功能端点，能够对数据进行深度增强，添加公司概况、融资数据、技术栈等有价值的信息。

请求处理：使用POST方法，在处理请求时会先检查请求体大小，确保数据在合理范围内。同时，会通过环境变量或请求头获取所需的API密钥，如果缺少API密钥，会返回相应的错误信息。

数据处理流程：该端点会调用多个专业化的代理（agents），如公司概况代理、融资代理、技术栈代理等，对数据进行多维度的增强处理。每个代理都有其特定的输出类型，确保增强后的数据具有结构化和准确性。

聊天交互：/api/chat

功能：提供基于数据的聊天交互能力，可利用已有的表格数据或进行网络搜索来回答用户的问题。

使用场景：当你需要基于处理后的数据与用户进行交互，或者需要为用户提供基于特定数据的咨询服务时，该端点非常有用。

API请求与响应格式

请求格式要求

大多数Fire-Enrich API端点采用POST方法，请求体通常为JSON格式。在发送请求时，需要确保请求体的格式正确，并且包含必要的参数。对于一些需要API密钥的端点，可以在请求头中传递相关密钥。

响应格式说明

API的响应通常为JSON格式，包含成功或错误的状态信息以及相应的数据。例如，在数据增强后，响应会包含结构化的增强数据，其中可能包括字段值、置信度和来源等信息。

相关的响应格式定义可以在lib/services/specialized-agents.ts等文件中找到，这些定义确保了API输出的一致性和可靠性。

集成步骤与最佳实践

集成步骤

配置API密钥：确保已正确设置所需的API密钥，可以通过环境变量或请求头传递。
选择合适的API端点：根据你的应用需求，选择相应的API端点，如数据抓取、字段生成或数据增强等。
构建请求：按照API的要求构建请求体，确保格式正确且包含必要的参数。
处理响应：接收API的响应，解析其中的数据，并根据应用的需要进行进一步的处理和展示。

最佳实践

错误处理：在调用API时，要妥善处理可能出现的错误，如API密钥缺失、请求格式错误等，为用户提供友好的提示。
请求频率控制：Fire-Enrich API有一定的请求频率限制，如允许每天每个IP每个端点50个请求，在集成时要注意控制请求频率，避免触发限制。
数据验证：对接收到的API响应数据进行验证，确保数据的准确性和完整性，然后再用于应用的业务逻辑。

常见问题解答

Q：如何解决API调用时出现的"Missing API keys"错误？A：出现该错误通常是因为未正确配置所需的API密钥。你可以检查环境变量中是否设置了OPENAI_API_KEY和FIRECRAWL_API_KEY等必要密钥，或者在请求头中传递这些密钥。

Q：API返回的增强数据中，置信度和来源有什么作用？A：置信度表示数据的可靠程度，来源则说明了数据的获取途径。这些信息可以帮助你评估数据的质量，在应用中根据实际需求决定如何使用这些数据。

通过本手册的介绍，你已经了解了Fire-Enrich API的基本情况、使用方法和集成要点。现在，你可以开始将Fire-Enrich的智能数据增强能力集成到你的应用中，为用户提供更丰富、更有价值的数据服务。如果在集成过程中遇到问题，可以参考项目中的相关代码文件，如app/api/enrich/route.ts等，获取更详细的实现信息。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考