Skip to main content
POST

承認

Authorization
string
header
必須

Bearer 形式のBearer認証ヘッダー。はあなたの認証トークンです。

ボディ

application/json
url
string<uri>
必須

リンクを取得したいウェブサイトのURL

search_query
string

検索の関連性でリンクをソートするためのオプションの検索クエリ。

top_n
number

検索クエリの上位nリンクのみに制限するためのオプションの数。

include_subdomain
boolean

指定されたURLのサブドメインを含める。デフォルトはtrueです。

include_urls
string[]

グロブ構文を使用して含めるURLパスパターン。例えば、/blog/**はブログURLのみを含めます。これらのパターンに一致するURLのみが返されます。

exclude_urls
string[]

グロブ構文を使用して除外するURLパスパターン。例えば、/careers/**。除外されたURLは含まれるURLよりも優先されます。

cursor
string

オプション: 前のレスポンスからのページネーションカーソル。指定された場合、前回のリクエストがレスポンスサイズ制限のために終了した場所から次のURLセットを返します。

レスポンス

ページ上で見つかったURLを含む成功したレスポンス。

urls_count
integer
必須

現在のレスポンスに含まれるURLの数

urls
string[]
必須

ページ上で見つかったURLの配列

id
string

このマップのユニークな識別子

cursor
string

10MBのサイズ制限のために制限された次のURLセットを取得するためのページネーションカーソル。nullまたは存在しない場合、すべてのURLが取得されています。

credits_consumed
integer | null

このリクエストで消費されたクレジットの数。実行完了後に設定されるよ。クレジットは請求の基準だよ。

cost_usd
number | null

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