创建批处理 - Olostep Docs

curl --request POST \ --url https://api.olostep.com/v1/batches \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "items": [ { "custom_id": "product-123", "url": "https://example.com/product/123", "metadata": { "source": "catalog_sync", "priority": "high" } }, { "custom_id": "product-456", "url": "https://example.com/product/456" } ], "country": "US", "metadata": { "batch_name": "Q1 Product Sync", "initiated_by": "automation" } } '

{ "id": "batch_abc123def456", "object": "batch", "status": "in_progress", "created": 1704067200, "total_urls": 2, "completed_urls": 0, "country": "US", "metadata": { "batch_name": "Q1 Product Sync", "initiated_by": "automation" } }

授权

Authorization

string

header

必填

Bearer认证头格式为Bearer ，其中是你的认证令牌。

请求体

application/json

items

object[]

必填

要在批处理中处理的项目数组。

Show child attributes

country

string

批处理执行的国家。请使用 ISO 3166-1 alpha-2 代码，如 US（美国）、IN（印度）等。

parser

object

你可以使用这个参数来指定要使用的解析器。解析器对于从网页中提取结构化内容非常有用。Olostep 内置了一些常见网页的解析器，你也可以创建自己的解析器。

Show child attributes

links_on_page

object

获取批处理中每个页面上存在的所有链接。链接始终以绝对 URL 返回。

Show child attributes

metadata

object

用于存储对象附加信息的键值对集合。遵循Stripe的验证规则：最多50个键，键最多40个字符（不含方括号），值最多500个字符，所有值以字符串形式存储。

Show child attributes

示例:

{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}

webhook

string<uri>

当批处理完成时接收 POST 请求的 HTTPS URL。必须是使用 http:// 或 https:// 协议的公开可访问 URL。不能指向 localhost 或私有 IP 地址。查看 Webhooks 了解负载格式和重试行为。

响应

批处理启动成功。

string

批处理 ID

object

string

对象的类型。此端点为 "batch"。

status

string

in_progress 或 completed

created

number

创建的纪元时间

total_urls

number

批处理中 URL 的数量

completed_urls

number

已完成的 URL 数量

parser

string

country

string

metadata

object

Show child attributes

示例:

{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}

webhook

string

用于接收完成通知的 Webhook URL

credits_consumed

integer | null

此请求消耗的积分数量。在执行完成后填充。积分是计费的真实来源。

cost_usd

number | null

此请求的估计成本（以美元计）。在执行完成后填充。根据消耗的积分和你的计划费率计算——99% 准确，但 credits_consumed 是权威值。