GET
/
v1
/
docs
/
{doc_id}
Get Doc Contents
curl --request GET \
  --url https://api.reportify.cn/v1/docs/{doc_id} \
  --header 'Authorization: Bearer <token>'
{
  "doc_id": "<string>",
  "title": "<string>",
  "url": "<string>",
  "institution": "<string>",
  "author": "<string>",
  "published_at": 123,
  "category": "financials",
  "market": "cn",
  "ticker": "<string>",
  "symbol": "<string>",
  "company_name": "<string>",
  "logo": "<string>",
  "companies": [
    {
      "name": "<string>",
      "logo": "<string>",
      "stocks": [
        {
          "symbol": "<string>",
          "market": "<string>",
          "code": "<string>"
        }
      ]
    }
  ],
  "tags": {},
  "metadatas": {},
  "report_type": 123,
  "channel_id": "<string>",
  "channel_name": "<string>",
  "file_url": "<string>",
  "media_url": "<string>",
  "chunks": [
    {
      "id": "<string>",
      "type": "text",
      "media_url": "<string>",
      "content": "<string>",
      "summary": "<string>",
      "metadata": {}
    }
  ]
}

​
文档内容

URL: /v1/docs/{doc_id}
方法: GET
描述: 获取指定文档的详细内容，包括文档信息及内容块（chunks）。

​
请求参数

参数名类型描述
doc_idstr文档唯一 ID。

​
响应参数

参数名类型描述
doc_idstr文档唯一 ID。
titlestr文档标题。
urlstr文档网页链接。
file_urlstr文档文件链接。
media_urlstr媒体文件链接。
institutionstr发布机构。
authorstr作者。
published_datestr发布时间，格式为 YYYY-MM-DD。
categorystr文档类别（financials, transcripts, reports, filings, news, socials, files）。
marketstr市场区域（cn, hk, us）。
symbolstr股票代码。
company_namestr公司名称。
logostr公司 Logo 链接。
summarystr文档摘要。
chunksarray内容块数组，每个块包含以下字段：
  typestr内容类型，可能的值为 text，table，image，formula。
  media_urlstr内容块的媒体文件链接（如果类型为 table，image，formula 时提供图片链接）。
  contentstr内容原始文本（适用于 text 或 table 类型）。
  summarystr解析内容，适用于 table，image，formula 类型。
  tagsdict标签字典，包含以下字段：
      keystr标签类型（如 industry, company, person, event）。
      valuearray标签内容数组。
  metadatasdict元数据字典，包含以下字段：
      keystr元数据类型（如 periods, entities）。
      valuearray元数据内容数组。

​
请求示例

cURL 
curl -X GET https://api.reportify.cn/v1/docs/1046895208953942016 \
-H "Authorization: Bearer 447460****09c9" \
-H "Content-Type: application/json"
Python 示例 
import requests

url = "https://api.reportify.cn/v1/docs/1046895208953942016"
headers = {
    "Authorization": "Bearer 447460****09c9",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

​
响应示例

{
  "doc_id": "1046895208953942016",
  "title": "AI in Finance Report",
  "url": "https://reportify.cn/financials/1046895208953942016",
  "file_url": "https://files.reportify.cn/media/production/TSLA5a08ddfbb97bd6486fff7a3875e7fe28_20241024183012.pdf",
  "media_url": "https://files.reportify.cn/media/production/s_4728833_9e25b61b62960211e6040eb2b81b352c.mp3",
  "institution": "Morgan Stanley",
  "author": "Jane Doe",
  "published_date": "2023-12-31",
  "category": "reports",
  "type": "research_report_company",
  "market": "us",
  "symbol": "AAPL",
  "company_name": "Apple Inc.",
  "logo": "https://files.reportify.cn/logo/AAPL.svg",
  "summary": "This report provides an overview of AI applications in finance...",
  "chunks": [
    {
      "type": "text",
      "media_url": "",
      "content": "AI in finance is transforming the industry...",
      "summary": ""
    },
    {
      "type": "table",
      "media_url": "https://files.reportify.cn/media/production/447460783945158/520072899438150/605401659404358/element/4.jpg",
      "content": "",
      "summary": "Financial data for AI companies in 2023"
    }
  ],
  "tags": {
    "industry": [
      "AI",
      "EV"
    ],
    "company": [
      "Tesla"
    ]
  },
  "metadatas": {
    "periods": "Q4 2023",
    "entities": [
      "Tesla Inc.",
      "TSLA"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
doc_id
string
required

Response

200
application/json

Successful Response

The response is of type object.