> ## 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.

# Crawl Info

> Fetches information about a specific crawl.



## OpenAPI

````yaml openapi/crawls.json GET /v1/crawls/{crawl_id}
openapi: 3.0.3
info:
  title: Crawl API
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/crawls/{crawl_id}:
    get:
      summary: Retrieve crawl information
      description: Fetches information about a specific crawl using its `crawl_id`.
      parameters:
        - name: crawl_id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the crawl to retrieve information for.
      responses:
        '200':
          description: Successful response with crawl information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Crawl ID
                  object:
                    type: string
                    description: The kind of object. "crawl" for this endpoint.
                  status:
                    type: string
                    description: '`in_progress` or `completed`'
                  created:
                    type: number
                    description: Created time in epoch
                  start_date:
                    type: string
                    description: Created time in date
                  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: The current depth of the crawl process.
                  pages_count:
                    type: number
                    description: Count of pages crawled
                  webhook:
                    type: string
                  follow_robots_txt:
                    type: boolean
                  credits_consumed:
                    type: integer
                    nullable: true
                    description: >-
                      Number of credits consumed by this request. Populated
                      after execution completes. Credits are the source of truth
                      for billing.
                  cost_usd:
                    type: number
                    nullable: true
                    description: >-
                      Estimated cost in USD for this request. Populated after
                      execution completes. Calculated from credits consumed and
                      your plan rate — 99% accurate, but credits_consumed is the
                      authoritative value.
        '400':
          description: Bad request due to incorrect or missing parameters.
        '404':
          description: Crawl not found for the provided ID.
        '500':
          description: Internal server error.
      security:
        - Authorization: []
components:
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form Bearer <token>, where <token>
        is your auth token.

````