メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

現在はBatchesで利用可能です。 Scrapes、Crawls、Maps、Answersへのサポートは近日中に追加予定です。
メタデータを使用すると、Olostepリソースにカスタムのキーと値のペアを添付できます。これは、APIリクエストと共にコンテキストを追跡、フィルタリング、整理、保存するのに役立ちます。 メタデータはStripeのアプローチに従っています。シンプルで柔軟、かつすべてのエンドポイントで一貫しています。

​
ユースケース

追跡と整理

リソースを注文ID、顧客ID、またはプロジェクト名で内部システムにリンクします。

フィルタリングと検索

リソースにタグを付けて、アプリケーション内で簡単に取得およびフィルタリングできるようにします。

ワークフローコンテキスト

パイプラインのステージ、優先度レベル、または処理指示を保存します。

監査証跡

リクエストを開始した人、タイムスタンプ、またはバージョン情報を記録します。

​
作成時のメタデータの追加

リソースを作成する際にmetadataパラメータを含めます: 
{
  "url": "https://example.com",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "internal_ref": "proj-2024-001"
  }
}
メタデータは、そのリソースに対するすべての後続のGETレスポンスで返されます。

​
検証ルール

制約制限エラー例
最大キー数50"メタデータは最大50個のキーを持つことができます。あなたは51個のキーを提供しました。"
キーの長さ40文字"メタデータキー \"my_very_long_key_name...\" が40文字の制限を超えています。"
キーの形式角括弧なし"メタデータキー \"items[0]\" に角括弧（[ または ]）を含めることはできません。"
値の長さ500文字"キー \"description\" のメタデータ値が500文字の制限を超えています。"
値の型文字列のみ"キー \"count\" のメタデータ値は文字列でなければなりません。オブジェクトを取得しました。"
型の強制: 数字とブール値は自動的に文字列に変換されます。
  • 42 → "42"
  • true → "true"
  • 3.14 → "3.14"
オブジェクトと配列は拒否されます。

​
メタデータの更新 (PATCH)

現在利用可能: Batches のみ。Crawls、Scrapes、Maps、Answersは作成後のメタデータ更新をまだサポートしていません。
既存のバッチに対してPATCHエンドポイントを使用してメタデータを更新できます。更新はマージ動作を使用します。

​
更新操作

既存のキーを保持しながら新しいキーを追加します。
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"new_key": "new_value"}}'
前: {"project": "alpha"}
後: {"project": "alpha", "new_key": "new_value"}
既存のキーは新しい値で上書きされます。
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"project": "beta"}}'
前: {"project": "alpha", "priority": "high"}
後: {"project": "beta", "priority": "high"}
キーをnullまたは""（空文字列）に設定して削除します。
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"priority": null}}'
前: {"project": "alpha", "priority": "high"}
後: {"project": "alpha"}
メタデータフィールド全体をnullまたは""に設定してすべてのキーを削除します。
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": null}'
前: {"project": "alpha", "priority": "high"}
後: {}
1つのリクエストでキーを追加、更新、削除します。
curl -X PATCH "https://api.olostep.com/v1/batches/batch_abc123" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{"metadata": {"project": "gamma", "new_field": "value", "old_field": null}}'
前: {"project": "alpha", "old_field": "remove_me"}
後: {"project": "gamma", "new_field": "value"}

​
PATCH動作の概要

操作リクエスト結果
キーの追加{"metadata": {"new": "value"}}キーが追加され、他のキーは保持される
キーの更新{"metadata": {"existing": "new_value"}}キーが更新され、他のキーは保持される
キーの削除{"metadata": {"key": null}}キーが削除され、他のキーは保持される
キーの削除{"metadata": {"key": ""}}キーが削除され、他のキーは保持される
すべてをクリア{"metadata": null}すべてのキーが削除される
すべてをクリア{"metadata": ""}すべてのキーが削除される
変更なし{"metadata": {}}変更なし