Skip to main content
POST
LLMでページから構造化データを抽出する
注意: 本APIの機能とパフォーマンスが向上した新しい v2 バージョン が利用可能です。

承認

Authorization
string
header
必須

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

ボディ

application/json
urls
string<uri>[]
必須

データを抽出する対象のURLです。URLはglobパターン形式で指定してください。

true の場合、抽出では Web 検索を使用して追加データを取得します

ignoreInvalidURLs
boolean
デフォルト:false

urls 配列に無効な URL が指定されている場合、それらは無視されます。リクエスト全体が失敗するのではなく、有効な URL のみを使って抽出処理が実行され、無効な URL はレスポンスの invalidURLs フィールドに返されます。

ignoreSitemap
boolean
デフォルト:false

true の場合、ウェブサイトのスキャン時に sitemap.xml ファイルは無視されます。

includeSubdomains
boolean
デフォルト:true

true の場合、指定した URL のサブドメインもスキャン対象になります

prompt
string

抽出プロセスを指示するプロンプト

schema
object

抽出されたデータの構造を定義するスキーマ。JSON Schema に準拠している必要があります。

scrapeOptions
object
showSources
boolean
デフォルト:false

true の場合、データ抽出に使用されたソースが、レスポンス内の sources キーとして含まれます

threatProtection
Threat Protection Override · object

リクエスト単位の脅威保護オーバーライドです。指定したフィールドは、このリクエストに限り、組織のポリシー内の対応するフィールドを上書きします。省略したフィールドには組織レベルの値がそのまま使用されます。利用するには、チームで脅威保護(エンタープライズ機能)が有効になっている必要があります。そうでない場合、リクエストは 403 で拒否されます。組織でリクエストのオーバーライドが無効になっている場合、このオブジェクトを含むリクエストはすべて 403 で拒否されます。チームで脅威保護の適用が必須になっている場合、modeoff は設定できません。

レスポンス

抽出成功

id
string
invalidURLs
string[] | null

ignoreInvalidURLs が true の場合、これはリクエスト内で指定された無効な URL を含む配列です。無効な URL がなかった場合、この配列は空になります。ignoreInvalidURLs が false の場合、このフィールドは undefined になります。

success
boolean