マップの作成 - Olostep Docs

curl --request POST \ --url https://api.olostep.com/v1/maps \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "url": "https://docs.olostep.com" } '

{ "id": "map_abc123", "urls_count": 22, "urls": [ "https://docs.olostep.com/api-reference/batches/create", "https://docs.olostep.com/api-reference/batches/info", "https://docs.olostep.com/api-reference/batches/items" ] }

curl --request POST \ --url https://api.olostep.com/v1/maps \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "url": "https://docs.olostep.com" } '

承認

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の配列

string

この地図のユニークな識別子

cursor

string

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

credits_consumed

integer | null

このリクエストで消費されたクレジットの数。実行完了後に入力されるよ。クレジットは請求の真実の源だよ。

cost_usd

number | null

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