fix: rename monitor 'cron' field to 'interval' to match API contract

Integration testing revealed the v2 API expects 'interval' not 'cron'
for the monitor create endpoint. Updated model, both clients, all tests,
examples, and migration guide.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: VinciGit00

examples/async_monitor_example.py

@@ -15,7 +15,7 @@ async def main():
             name="Async Price Tracker",
             url="https://example.com/products",
             prompt="Extract product prices",
-            cron="0 12 * * *",  # Every day at noon
+            interval="0 12 * * *",  # Every day at noon
         )
         print("Created:", json.dumps(monitor, indent=2))
 

examples/monitor_create_example.py

@@ -1,7 +1,7 @@
 """
 Create a monitor to track changes on a webpage.
 
-Monitors run on a cron schedule and use AI to extract data each time.
+Monitors run on an interval (cron expression) and use AI to extract data each time.
 This replaces the old scheduled jobs API.
 """
 
@@ -15,7 +15,7 @@
     name="Daily Price Tracker",
     url="https://example.com/products",
     prompt="Extract all product names and prices",
-    cron="0 9 * * *",  # Every day at 9am
+    interval="0 9 * * *",  # Every day at 9am
 )
 print("Monitor created:", json.dumps(monitor, indent=2))
 

examples/monitor_with_config_example.py

@@ -12,7 +12,7 @@
     name="Stealth News Monitor",
     url="https://example.com/news",
     prompt="Extract the top 5 news headlines with their dates",
-    cron="0 */6 * * *",  # Every 6 hours
+    interval="0 */6 * * *",  # Every 6 hours
     fetch_config=FetchConfig(
         mode="js+stealth",
         wait=2000,

examples/monitor_with_schema_example.py

@@ -33,7 +33,7 @@
     name="Weekly Product Monitor",
     url="https://example.com/shop",
     prompt="Extract all product names, prices, and currencies",
-    cron="0 8 * * 1",  # Every Monday at 8am
+    interval="0 8 * * 1",  # Every Monday at 8am
     output_schema=schema,
 )
 print("Monitor created:", json.dumps(monitor, indent=2))

scrapegraph-py/MIGRATION_V2.md

@@ -349,7 +349,7 @@ client.crawl.resume(crawl_id)
 
 ### Scheduled Jobs → `monitor.*`
 
-The entire scheduled jobs API has been replaced by the **monitor** namespace. Monitors are simpler: instead of configuring a `service_type` + `job_config`, you directly provide a `url`, `prompt`, and `cron`.
+The entire scheduled jobs API has been replaced by the **monitor** namespace. Monitors are simpler: instead of configuring a `service_type` + `job_config`, you directly provide a `url`, `prompt`, and `interval` (a cron expression).
 
 #### v1
 
@@ -397,7 +397,7 @@ monitor = client.monitor.create(
     name="Daily Scraper",
     url="https://example.com",
     prompt="Extract company info",
-    cron="0 9 * * *",
+    interval="0 9 * * *",
     output_schema={"type": "object", "properties": {"name": {"type": "string"}}},
     fetch_config=FetchConfig(mode="direct+stealth"),
     llm_config=LlmConfig(temperature=0.1),
@@ -602,7 +602,7 @@ async def main():
             name="Tracker",
             url="https://example.com",
             prompt="Extract prices",
-            cron="0 9 * * *",
+            interval="0 9 * * *",
         )
 
 asyncio.run(main())

scrapegraph-py/scrapegraph_py/async_client.py

@@ -98,7 +98,7 @@ async def create(
         name: str,
         url: str,
         prompt: str,
-        cron: str,
+        interval: str,
         output_schema: Optional[Dict[str, Any]] = None,
         fetch_config: Optional[FetchConfig] = None,
         llm_config: Optional[LlmConfig] = None,
@@ -109,7 +109,7 @@ async def create(
             name=name,
             url=url,
             prompt=prompt,
-            cron=cron,
+            interval=interval,
             output_schema=output_schema,
             fetch_config=fetch_config,
             llm_config=llm_config,

scrapegraph-py/scrapegraph_py/client.py

@@ -121,7 +121,7 @@ def create(
         name: str,
         url: str,
         prompt: str,
-        cron: str,
+        interval: str,
         output_schema: Optional[Dict[str, Any]] = None,
         fetch_config: Optional[FetchConfig] = None,
         llm_config: Optional[LlmConfig] = None,
@@ -132,7 +132,7 @@ def create(
             name: Name of the monitor
             url: URL to monitor
             prompt: Prompt for AI extraction
-            cron: Cron expression (5 fields)
+            interval: Cron expression (5 fields)
             output_schema: Optional JSON Schema for structured output
             fetch_config: Fetch configuration options
             llm_config: LLM configuration options
@@ -142,7 +142,7 @@ def create(
             name=name,
             url=url,
             prompt=prompt,
-            cron=cron,
+            interval=interval,
             output_schema=output_schema,
             fetch_config=fetch_config,
             llm_config=llm_config,

scrapegraph-py/scrapegraph_py/models/monitor.py

@@ -22,7 +22,7 @@ class MonitorCreateRequest(BaseModel):
     name: str = Field(..., description="Name of the monitor")
     url: str = Field(..., description="URL to monitor")
     prompt: str = Field(..., description="Prompt for AI extraction")
-    cron: str = Field(..., description="Cron expression for scheduling (5 fields)")
+    interval: str = Field(..., description="Cron expression for scheduling (5 fields)")
     output_schema: Optional[Dict[str, Any]] = Field(
         default=None,
         description="JSON Schema defining the structure of extracted data",
@@ -44,9 +44,9 @@ def validate_fields(self) -> "MonitorCreateRequest":
             raise ValueError("URL must start with http:// or https://")
         if not self.prompt or not self.prompt.strip():
             raise ValueError("Prompt cannot be empty")
-        parts = self.cron.strip().split()
+        parts = self.interval.strip().split()
         if len(parts) != 5:
-            raise ValueError("Cron expression must have exactly 5 fields")
+            raise ValueError("Interval cron expression must have exactly 5 fields")
         return self
 
     def model_dump(self, *args: Any, **kwargs: Any) -> Dict[str, Any]:

scrapegraph-py/tests/test_async_client.py

@@ -240,7 +240,7 @@ async def test_monitor_create(client):
             name="Price Monitor",
             url="https://example.com/products",
             prompt="Extract product prices",
-            cron="0 9 * * 1",
+            interval="0 9 * * 1",
         )
         assert result["name"] == "Price Monitor"
 

scrapegraph-py/tests/test_client.py

@@ -283,7 +283,7 @@ def test_monitor_create(client):
         name="Price Monitor",
         url="https://example.com/products",
         prompt="Extract product prices",
-        cron="0 9 * * 1",
+        interval="0 9 * * 1",
     )
     assert result["name"] == "Price Monitor"