feat(api): explain failed scrape outputs and fix agent-reported bugs (#1360)

Stainless-Generated-From: ced3f67

Author: stlc-bot

src/context/dev/types/web_scrape_response.py

@@ -48,6 +48,12 @@ class Bytes(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class CacheMetadata(BaseModel):
     """Whether this response came from cache."""
@@ -75,6 +81,12 @@ class Highlights(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class HTML(BaseModel):
     """Rendered HTML after content filters."""
@@ -86,6 +98,12 @@ class HTML(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class ImagesData(BaseModel):
     alt: Optional[str] = None
@@ -119,6 +137,12 @@ class Images(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class Json(BaseModel):
     """Object matching `jsonParams.schema`."""
@@ -131,10 +155,10 @@ class Json(BaseModel):
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
     error_code: Optional[str] = None
-    """Cause of a failed JSON extraction, when available."""
+    """Why the output failed. Present only when `success` is `false`."""
 
     message: Optional[str] = None
-    """Explanation of the JSON extraction failure and possible next steps."""
+    """Explanation of the failure and possible next steps."""
 
 
 class Markdown(BaseModel):
@@ -147,6 +171,12 @@ class Markdown(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class MetadataAlternate(BaseModel):
     href: str
@@ -241,6 +271,12 @@ class Parsed(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class ProductDataProductVariant(BaseModel):
     attributes: Dict[str, str]
@@ -336,6 +372,12 @@ class Product(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class Screenshot(BaseModel):
     """Screenshot as a base64 image data URL."""
@@ -347,6 +389,12 @@ class Screenshot(BaseModel):
     success: Optional[bool] = None
     """`true` if returned, `false` if it failed, `null` if not requested."""
 
+    error_code: Optional[str] = None
+    """Why the output failed. Present only when `success` is `false`."""
+
+    message: Optional[str] = None
+    """Explanation of the failure and possible next steps."""
+
 
 class KeyMetadata(BaseModel):
     """Credits this request used and your remaining balance."""