クロール

Olostepの/v1/crawlsエンドポイントを使用して、ウェブサイトをクロールし、すべてのページからコンテンツを取得できます。

ウェブサイトをクロールしてすべてのサブページからコンテンツを取得（またはクロールの深さを制限）
特定のページをクロールするための特別なパターンを使用（例：/blog/**）
クロールが完了したときに通知を受け取るためにwebhook_urlを渡す
特定のページのみを見つけて関連性でソートする検索クエリ

APIの詳細については、クロールエンドポイントAPIリファレンスを参照してください。

インストール

pip install olostep

npm install olostep

# curlはmacOS、Linux、Windowsでデフォルトで利用可能

npm install node-fetch

pip install requests

クロールを開始

開始URL、含める/除外するURLグロブ、max_pagesを指定します。オプション: max_depth、include_external、include_subdomain、search_query、top_n、webhook_url、timeout。

from olostep import Olostep

client = Olostep(api_key="YOUR_REAL_KEY")

crawl = client.crawls.create(
    start_url="https://olostep.com",
    max_pages=100,
    include_urls=["/**"],
    exclude_urls=["/collections/**"],
    include_external=False,
)

print(crawl.id, crawl.status)

import Olostep from 'olostep'

const client = new Olostep({ apiKey: 'YOUR_REAL_KEY' })

const crawl = await client.crawls.create({
  url: 'https://olostep.com',
  maxPages: 100,
  includeUrls: ['/**'],
  excludeUrls: ['/collections/**'],
  includeExternal: false,
})

console.log(crawl.id, crawl.status)

curl -s -X POST "https://api.olostep.com/v1/crawls" \
  -H "Authorization: Bearer $OLOSTEP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "start_url": "https://olostep.com",
    "max_pages": 100,
    "include_urls": ["/**"],
    "exclude_urls": ["/collections/**"]
  }'

olostep crawl "https://olostep.com" \
  --max-pages 100 \
  --include-url "/**" \
  --exclude-url "/collections/**" \
  --formats markdown,html

const API_URL = 'https://api.olostep.com'
const res = await fetch(`${API_URL}/v1/crawls`, {
  method: 'POST',
  headers: { 'Authorization': 'Bearer <YOUR_API_KEY>', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    start_url: 'https://olostep.com',
    max_pages: 100,
    include_urls: ['/**'],
    exclude_urls: ['/collections/**']
  })
})
console.log(await res.json())

import time, json

API_URL = 'https://api.olostep.com'
API_KEY = '<YOUR_API_KEY>'
HEADERS = { 
    'Content-Type': 'application/json',
    'Authorization': f'Bearer {API_KEY}' 
}

data = {
  "start_url": "https://olostep.com",
  "max_pages": 100,
  "include_urls": ["/**"],
  "exclude_urls": ["/collections/**"],
  "include_external": False
}

res = requests.post(f"{API_URL}/v1/crawls", headers=HEADERS, json=data)
crawl = res.json()
print(json.dumps(crawl, indent=2))

Olostepではすべてがオブジェクトであるため、レスポンスとしてcrawlオブジェクトを受け取ります。crawlオブジェクトには、クロールを追跡するために使用できるidやstatusなどのプロパティがあります。

クロールのステータスを確認

クロールをポーリングして、statusがcompletedになるまで進捗を追跡します。

# 前のステップからのクロールオブジェクトを使用
info = crawl.info()
print(info.status, info.pages_count)

# または完了するまで待つ
crawl.wait_till_done(check_every_n_secs=5)

// 前のステップからのクロールオブジェクトを使用
const info = await crawl.info()
console.log(info.status, info.pages_count)

// または完了するまで待つ
await crawl.waitTillDone({ checkEveryNSecs: 5 })

curl -s -X GET "https://api.olostep.com/v1/crawls/<CRAWL_ID>" \
  -H "Authorization: Bearer $OLOSTEP_API_KEY"

const crawlId = '<CRAWL_ID>'
const status = await fetch(`${API_URL}/v1/crawls/${crawlId}`, {
  headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' }
}).then(r => r.json())
console.log(status)

import time

def get_crawl_info(crawl_id):
    return requests.get(f'{API_URL}/v1/crawls/{crawl_id}', headers=HEADERS).json()

crawl_id = crawl['id']
while True:
    info = get_crawl_info(crawl_id)
    print(info['status'], info.get('pages_count'))
    if info['status'] == 'completed':
        break
    time.sleep(5)

または、クロールを開始するときにwebhook_urlを渡して、クロールが完了したときに通知を受け取ることができます。

ページをリストする（カーソルでページネート/ストリーム）

cursorとlimitを使用してページを取得し、反復します。クロールがin_progressまたはcompletedの間に動作します。

# すべてのページを反復（クロール完了を自動待機、ページネーションを処理）
for page in crawl.pages():
    print(page.url, page.retrieve_id)

// すべてのページを反復（クロール完了を自動待機、ページネーションを処理）
for await (const page of crawl.pages()) {
  console.log(page.url, page.retrieve_id)
}

curl -s -G "https://api.olostep.com/v1/crawls/<CRAWL_ID>/pages" \
  -H "Authorization: Bearer $OLOSTEP_API_KEY" \
  --data-urlencode "cursor=0" \
  --data-urlencode "limit=10"

let cursor = 0
while (true) {
  const pages = await fetch(`${API_URL}/v1/crawls/${crawlId}/pages?cursor=${cursor}&limit=10`, {
    headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' }
  }).then(r => r.json())
  pages.pages.forEach(p => console.log(p.url, p.retrieve_id))
  if (pages.cursor === undefined) break
  cursor = pages.cursor
}

def get_pages(crawl_id, cursor=None, limit=10, search_query=None):
    params = { 
        'cursor': cursor, 
        'limit': limit
    }
    return requests.get(f'{API_URL}/v1/crawls/{crawl_id}/pages', headers=HEADERS, params=params).json()

cursor = 0
while True:
    page_batch = get_pages(crawl_id, cursor=cursor, limit=10)
    for page in page_batch['pages']:
        print(page['url'], page['retrieve_id'])
    if 'cursor' not in page_batch:
        break
    cursor = page_batch['cursor']
    time.sleep(5)

検索クエリ（関連性の高い上位N件に制限）

開始時にsearch_queryを使用し、オプションでsearch_queryでリストをフィルタリングします。ページごとの探索をtop_nで制限します。

from olostep import Olostep

client = Olostep(api_key="YOUR_REAL_KEY")

crawl = client.crawls.create(
    start_url="https://olostep.com",
    max_pages=100,
    include_urls=["/**"],
    search_query="contact us",
    top_n=5,
)

for page in crawl.pages(search_query="contact us"):
    print(page.url)

import Olostep from 'olostep'

const client = new Olostep({ apiKey: 'YOUR_REAL_KEY' })

const crawl = await client.crawls.create({
  url: 'https://olostep.com',
  maxPages: 100,
  includeUrls: ['/**'],
  searchQuery: 'contact us',
  topN: 5,
})

for await (const page of crawl.pages()) {
  console.log(page.url)
}

curl -s -X POST "https://api.olostep.com/v1/crawls" \
  -H "Authorization: Bearer $OLOSTEP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "start_url": "https://olostep.com",
    "max_pages": 100,
    "include_urls": ["/**"],
    "search_query": "contact us",
    "top_n": 5
  }'

olostep crawl "https://olostep.com" \
  --max-pages 100 \
  --include-url "/**" \
  --search-query "contact us" \
  --top-n 5

await fetch(`${API_URL}/v1/crawls`, { method: 'POST', headers: { 'Authorization': 'Bearer <YOUR_API_KEY>', 'Content-Type': 'application/json' }, body: JSON.stringify({ start_url: 'https://olostep.com', max_pages: 100, include_urls: ['/**'], search_query: 'contact us', top_n: 5 }) })

data = {
  "start_url": "https://olostep.com",
  "max_pages": 100,
  "include_urls": ["/**"],
  "search_query": "contact us",
  "top_n": 5
}
crawl = requests.post(f'{API_URL}/v1/crawls', headers=HEADERS, json=data).json()
pages = requests.get(f"{API_URL}/v1/crawls/{crawl['id']}/pages", headers=HEADERS, params={'search_query': 'contact us'}).json()
print(len(pages['pages']))

コンテンツを取得

各ページのretrieve_idを使用して、/v1/retrieveからhtml_contentおよび/またはmarkdown_contentを取得します。

# クロールされた各ページのコンテンツを取得
for page in crawl.pages():
    content = page.retrieve(["markdown"])
    print(content.markdown_content)

// クロールされた各ページのコンテンツを取得
for await (const page of crawl.pages()) {
  const content = await client.retrieve.get(page.retrieve_id, ['markdown'])
  console.log(content.markdown_content)
}

curl -s -G "https://api.olostep.com/v1/retrieve" \
  -H "Authorization: Bearer $OLOSTEP_API_KEY" \
  --data-urlencode "retrieve_id=<RETRIEVE_ID>"

# `olostep crawl`はコンテンツを自動的に取得します。後でretrieve_idで単一のページを取得するには：
olostep scrape-get <RETRIEVE_ID>

const retrieved = await fetch(`${API_URL}/v1/retrieve?retrieve_id=<RETRIEVE_ID>`, { headers: { 'Authorization': 'Bearer <YOUR_API_KEY>' } }).then(r => r.json())
console.log(retrieved.markdown_content)

def retrieve_content(retrieve_id):
    return requests.get(f"{API_URL}/v1/retrieve", headers=HEADERS, params={"retrieve_id": retrieve_id}).json()

for page in get_pages(crawl['id'], limit=5)['pages']:
    retrieved = retrieve_content(page['retrieve_id'])
    print(retrieved.get('markdown_content'))

注意事項

ページネーションはカーソルベースです；cursorがなくなるまでリクエストを繰り返します。
/v1/crawls/{crawl_id}/pagesのコンテンツフィールドは非推奨です；/v1/retrieveを優先してください。
Webhooks: クロールが完了したときにPOSTを受け取るためにwebhook_urlを設定します。

ストレージ

クロールのために保存されたファイルはデフォルトで7日間保持されます。長期間または無期限に保持するために、POST /v1/crawlsでstorageオブジェクトを渡します。この設定は、後でretrieve_idで取得するコンテンツをカバーするため、クロール内のすべてのページスクレイプに適用されます。

パラメータ	タイプ	デフォルト	説明
`storage.expires_in`	`string`	`7d`	保存されたファイルを保持する期間。`7d`、`10d`、`30d`、`60d`、`90d`、`180d`、`365d`、または`never`（無期限）のいずれか。

storageを省略するか、expires_inなしでstorageを送信すると、7dが使用されます。作成レスポンスとGET /v1/crawls/{crawl_id}の両方に、実際の値が含まれています：

"storage": { "expires_in": "30d" }

cURL

curl -s -X POST "https://api.olostep.com/v1/crawls" \
  -H "Authorization: Bearer $OLOSTEP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "start_url": "https://example.com",
    "max_pages": 10,
    "storage": { "expires_in": "30d" }
  }'

無効な値は400を返します：

{
  "type": "invalid_request_error",
  "message": "Invalid storage.expires_in. Allowed values: \"7d\", \"10d\", \"30d\", \"60d\", \"90d\", \"180d\", \"365d\", \"never\".",
  "code": "invalid_storage_expires_in"
}

料金

クロールには、クロールされたページごとに1クレジットがかかります。

開始する

機能

残高と請求書

インストール

クロールを開始

クロールのステータスを確認

ページをリストする（カーソルでページネート/ストリーム）

検索クエリ（関連性の高い上位N件に制限）

コンテンツを取得

注意事項

ストレージ

料金

​インストール

​クロールを開始

​クロールのステータスを確認

​ページをリストする（カーソルでページネート/ストリーム）

​検索クエリ（関連性の高い上位N件に制限）

​コンテンツを取得

​注意事項

​ストレージ

​料金

インストール

クロールを開始

クロールのステータスを確認

ページをリストする（カーソルでページネート/ストリーム）

検索クエリ（関連性の高い上位N件に制限）

コンテンツを取得

注意事項

ストレージ

料金