> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# クロール情報

> 特定のクロールに関する情報を取得します。



## OpenAPI

````yaml ja/openapi/crawls.json GET /v1/crawls/{crawl_id}
openapi: 3.0.3
info:
  title: クローラーAPI
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/crawls/{crawl_id}:
    get:
      summary: クローリング情報を取得
      description: '`crawl_id` を使用して特定のクローリングに関する情報を取得します。'
      parameters:
        - name: crawl_id
          in: path
          required: true
          schema:
            type: string
          description: 情報を取得するためのクローリングのID。
      responses:
        '200':
          description: クローリング情報を含む成功したレスポンス。
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: クロールID
                  object:
                    type: string
                    description: オブジェクトの種類。このエンドポイントでは "crawl"。
                  status:
                    type: string
                    description: '`in_progress` または `completed`'
                  created:
                    type: number
                    description: エポックでの作成時間
                  start_date:
                    type: string
                    description: 日付での作成時間
                  start_url:
                    type: string
                  max_pages:
                    type: number
                  max_depth:
                    type: number
                  exclude_urls:
                    type: array
                    items:
                      type: string
                  include_urls:
                    type: array
                    items:
                      type: string
                  include_external:
                    type: boolean
                  search_query:
                    type: string
                  top_n:
                    type: number
                  current_depth:
                    type: number
                    description: クローリングプロセスの現在の深さ。
                  pages_count:
                    type: number
                    description: クロールされたページの数
                  webhook:
                    type: string
                  follow_robots_txt:
                    type: boolean
                  credits_consumed:
                    type: integer
                    nullable: true
                    description: このリクエストで消費されたクレジットの数。実行完了後に設定されるよ。クレジットは請求の基準だよ。
                  cost_usd:
                    type: number
                    nullable: true
                    description: >-
                      このリクエストのUSDでの推定コスト。実行完了後に設定されるよ。消費されたクレジットとプランのレートから計算されるよ
                      — 99%の精度だけど、credits_consumedが正確な値だよ。
        '400':
          description: 不正なリクエスト。パラメータが間違っているか、欠落しています。
        '404':
          description: 提供されたIDに対するクローリングが見つかりません。
        '500':
          description: 内部サーバーエラー。
      security:
        - Authorization: []
components:
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Bearer <token>形式のBearer認証ヘッダー。<token>はあなたの認証トークンです。

````