Company Research API

Start a company research report and manage the resulting notebook through status, download, and configuration endpoints. description: Workflow-based company research generation with JWT auth, company lookup, and report lifecycle endpoints included.

原始信息汇总

根据提供的HTML内容，以下是该数据集（API）的详细信息总结：

数据集（API）概述

• 名称：Company Research API
• 类别：Financial（金融）
• 提供者：Wokelo-AI
• 订阅者数量：1
• 定价：免费（Free）
• 描述：这是一个基于工作流的公司研究报告生成API，用于启动特定公司的研究报告，并管理整个工作流输出。它包含登录、公司查询、报告生成、笔记本状态检索、报告下载和配置查询等端点，开发者无需切换列表即可完成报告工作流。

主要功能

该API包含以下端点：

• POST /auth/token/：用用户名和密码交换JWT令牌，用于保护该列表中所有端点的访问。
• GET /api/enterprise/company/search：通过公司名称、网站或股票代码解析Wokelo公司候选对象。
• POST /api/workflow_manager/start/：为特定公司启动公司研究报告，并返回笔记本ID。
• GET /api/assets/get_notebook_status/：通过笔记本ID轮询工作流生成的笔记本或报告的生命周期状态。
• POST /api/assets/download_report/：报告完成后，下载docx、pdf或json格式的完成工作流输出。
• POST /api/wkl/notebook/configuration/：检索用于生成工作流报告的配置，以便审计或复现。

认证方式

使用 POST /auth/token/ 获取JWT令牌，然后在每个受保护端点中通过 Authorization: Bearer <JWT> 头发送该令牌。

使用流程

1. 启动报告：核心报告生成端点返回一个工作流笔记本ID（而非最终报告正文）。
2. 跟踪与下载：使用报告状态端点跟踪完成进度，报告就绪后下载，并可检查生成报告的配置。
3. 公司搜索：内置公司搜索功能，可从公司名称、网站或股票代码开始工作流。

示例用例

• 从应用程序工作流触发公司研究报告。
• 跟踪报告至完成，并下载支持格式的最终输出。
• 恢复原始笔记本配置，用于可重复性或审计需求。

参考资源

• 托管文档：https://wokelo-ai.github.io/openapi/
• 主规范文件：https://wokelo-ai.github.io/openapi/wokelo-openapi.yaml