バッチの作成 - 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(USA), IN(India) など）。

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

このリクエストのUSDでの推定コスト。実行完了後に入力されるよ。消費されたクレジットとあなたのプランレートから計算されるよ — 99% 正確だけど、credits_consumed が権威ある値だよ。