Hivebrowser
API 参考

产物

捕获截图、生成 PDF 与提取页面内容。

适用运行需要持久输出

为报告、下游系统、失败复盘或客户可见结果保存证据。

选择截图、PDF 或内容

视觉证明用截图，文档型页面用 PDF，文本或 HTML 交给内容提取。

追踪保存产物 id

把产物 id 写入任务记录，后续才能查询元数据或下载内容。

输出边界

截图用于视觉证明和失败复盘，PDF 用于发票、收据、报告等文档型页面，内容提取用于下游系统需要文本或 HTML 的场景。无论哪种产物，都应把产物 ID 写入任务记录，后续再查询元数据或下载内容。

捕获截图

POST/v1/screenshot查看接口细节收起接口细节
POST/v1/screenshot

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

请求体

application/json必填
sessionId必填字符串

要捕获的会话

最小长度: 1
fullPage布尔值

捕获完整可滚动页面

默认: false
format字符串

图片输出格式

默认: "png"可选值: "png" | "jpeg"
quality整数

JPEG 质量（1-100，仅适用于 jpeg 格式）

最小值: 1最大值: 100
cURL
curl -X POST "https://api.hivebrowser.ai/v1/screenshot" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string",    "fullPage": false,    "format": "png",    "quality": 1  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/screenshot", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string",    "fullPage": false,    "format": "png",    "quality": 1  })});
响应 201

截图已捕获

响应示例
{
  "data": {
    "id": "string",
    "teamId": "string",
    "sessionId": "string",
    "type": "SCREENSHOT",
    "storageKey": "string",
    "contentType": "string",
    "sizeBytes": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "downloadUrl": "http://example.com"
  }
}
响应 400

请求载荷无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

生成 PDF

POST/v1/pdf查看接口细节收起接口细节
POST/v1/pdf

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

请求体

application/json必填
sessionId必填字符串

要捕获的会话

最小长度: 1
format字符串

纸张格式（例如 A4、Letter）

默认: "A4"
landscape布尔值

使用横向页面方向

默认: false
printBackground布尔值

打印背景图形

默认: true
cURL
curl -X POST "https://api.hivebrowser.ai/v1/pdf" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string",    "format": "A4",    "landscape": false,    "printBackground": true  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/pdf", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string",    "format": "A4",    "landscape": false,    "printBackground": true  })});
响应 201

PDF 已生成

响应示例
{
  "data": {
    "id": "string",
    "teamId": "string",
    "sessionId": "string",
    "type": "SCREENSHOT",
    "storageKey": "string",
    "contentType": "string",
    "sizeBytes": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "downloadUrl": "http://example.com"
  }
}
响应 400

请求载荷无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

提取页面内容

POST/v1/content查看接口细节收起接口细节
POST/v1/content

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

请求体

application/json必填
sessionId必填字符串

要提取内容的会话

最小长度: 1
includeHtml布尔值

在响应中包含原始 HTML

默认: true
includeText布尔值

在响应中包含提取文本

默认: true
cURL
curl -X POST "https://api.hivebrowser.ai/v1/content" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "sessionId": "string",    "includeHtml": true,    "includeText": true  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/content", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "sessionId": "string",    "includeHtml": true,    "includeText": true  })});
响应 201

内容已提取

响应示例
{
  "data": {
    "artifact": {
      "id": "string",
      "teamId": "string",
      "sessionId": "string",
      "type": "SCREENSHOT",
      "storageKey": "string",
      "contentType": "string",
      "sizeBytes": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "downloadUrl": "http://example.com"
    },
    "content": {
      "url": "string",
      "title": "string",
      "html": "string",
      "text": "string"
    }
  }
}
响应 400

请求载荷无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

查询产物元数据

GET/v1/artifacts/{id}查看接口细节收起接口细节
GET/v1/artifacts/{id}

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

路径参数

id必填字符串

产物 ID

cURL
curl -X GET "https://api.hivebrowser.ai/v1/artifacts/string" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/artifacts/string", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

产物元数据

响应示例
{
  "data": {
    "id": "string",
    "teamId": "string",
    "sessionId": "string",
    "type": "SCREENSHOT",
    "storageKey": "string",
    "contentType": "string",
    "sizeBytes": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "downloadUrl": "http://example.com"
  }
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

下载产物内容

GET/v1/artifacts/{id}/content查看接口细节收起接口细节
GET/v1/artifacts/{id}/content

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

路径参数

id必填字符串

产物 ID

查询参数

token字符串

用于免登录下载的产物访问令牌

cURL
curl -X GET "https://api.hivebrowser.ai/v1/artifacts/string/content?token=string" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/artifacts/string/content?token=string", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

产物内容（content-type 取决于产物类型）

响应示例
"string"
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

本页目录

输出边界捕获截图生成 PDF提取页面内容查询产物元数据下载产物内容