Crawl4AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Crawl4AI Crawl API

3 actions 3 updates phrasing extends openapi/crawl4ai-crawl-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Crawl4AI's API. It is a proposal applied on top of the contract, not a document Crawl4AI publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/crawl/job'].post
$.paths['/crawl/job/{jobId}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Crawl4AI Crawl API
  version: 1.0.0
extends: openapi/crawl4ai-crawl-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/crawl/job'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a crawl job for a list of URLs
      effect: write
      questions:
      - How do I kick off a Crawl4AI job to scrape a batch of web pages?
      - Can I submit several URLs in one crawl request instead of one at a time?
      - What do I need to send to start crawling a website asynchronously?
      instructions:
      - text: Start a new crawl job for {urls}.
        slots:
          urls: requestBody.urls
      - text: 'Submit these pages to be crawled and scraped: {urls}.'
        slots:
          urls: requestBody.urls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/crawl/job/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a crawl job's status and results
      effect: read
      questions:
      - Is my crawl job finished yet, and where do I get the scraped results?
      - What status is a crawl job in after I've submitted it?
      - Can I fetch the extracted content once a crawl job completes?
      instructions:
      - text: Check the status of crawl job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the results of crawl job {jobId} if it has finished.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'