メインコンテンツへスキップ
POST
/
v1
/
maps
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" ] }

承認

​
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が取得されています。