feat(api): return request_id on every response

Stainless-Generated-From: ff6069e

Author: stlc-bot

README.md

@@ -36,7 +36,7 @@ brand = client.brand.retrieve(
     domain="REPLACE_ME",
     type="by_domain",
 )
-print(brand.cache_metadata)
+print(brand.request_id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -63,7 +63,7 @@ async def main() -> None:
         domain="REPLACE_ME",
         type="by_domain",
     )
-    print(brand.cache_metadata)
+    print(brand.request_id)
 
 
 asyncio.run(main())
@@ -100,7 +100,7 @@ async def main() -> None:
             domain="REPLACE_ME",
             type="by_domain",
         )
-        print(brand.cache_metadata)
+        print(brand.request_id)
 
 
 asyncio.run(main())
@@ -270,7 +270,7 @@ response = client.brand.with_raw_response.retrieve(
 print(response.headers.get('X-My-Header'))
 
 brand = response.parse()  # get the object that `brand.retrieve()` would have returned
-print(brand.cache_metadata)
+print(brand.request_id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/context-dot-dev/context-python-sdk/tree/main/src/context/dev/_response.py) object.

src/context/dev/types/ai_extract_product_response.py

@@ -103,6 +103,12 @@ class AIExtractProductResponse(BaseModel):
     to the output was a hit; age_ms is the oldest contributing hit.
     """
 
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     is_product_page: Optional[bool] = None
     """Whether the given URL is a product detail page"""
 

src/context/dev/types/ai_extract_products_response.py

@@ -101,6 +101,12 @@ class AIExtractProductsResponse(BaseModel):
     to the output was a hit; age_ms is the oldest contributing hit.
     """
 
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     key_metadata: Optional[KeyMetadata] = None
     """Credit usage, included whenever a valid API key is provided."""
 

src/context/dev/types/batch_cancel_response.py

@@ -83,6 +83,12 @@ class BatchCancelResponse(BaseModel):
     progress: Progress
     """How far the batch got before cancellation."""
 
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     status: Literal["cancelling"]
     """Always `cancelling`.
 

src/context/dev/types/batch_delete_response.py

@@ -18,6 +18,12 @@ class KeyMetadata(BaseModel):
 
 
 class BatchDeleteResponse(BaseModel):
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     id: Optional[str] = None
     """ID of the deleted batch."""
 

src/context/dev/types/batch_get_results_response.py

@@ -214,6 +214,12 @@ class KeyMetadata(BaseModel):
 
 
 class BatchGetResultsResponse(BaseModel):
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     data: Optional[List[Data]] = None
     """Result records on this page."""
 

src/context/dev/types/batch_list_response.py

@@ -169,6 +169,12 @@ class KeyMetadata(BaseModel):
 
 
 class BatchListResponse(BaseModel):
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     data: Optional[List[Data]] = None
     """Batches on this page."""
 

src/context/dev/types/batch_retrieve_response.py

@@ -162,6 +162,12 @@ class BatchRetrieveResponse(BaseModel):
     progress: Progress
     """Pages attempted so far. Use `status` to check completion."""
 
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     results: Optional[Results] = None
     """
     Download links, available once the batch reaches a final status and null before

src/context/dev/types/batch_submit_response.py

@@ -89,6 +89,12 @@ class BatchSubmitResponse(BaseModel):
     mode: Literal["scrape", "crawl"]
     """How pages will be selected."""
 
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     status: Literal["queued"]
     """Always `queued`. An accepted batch has not started yet."""
 

src/context/dev/types/brand_retrieve_response.py

@@ -711,6 +711,12 @@ class BrandRetrieveResponse(BaseModel):
     to the output was a hit; age_ms is the oldest contributing hit.
     """
 
+    request_id: str
+    """Unique id of this API call, also sent in the X-Request-Id response header.
+
+    Quote it when contacting support about a failed request.
+    """
+
     brand: Optional[Brand] = None
     """Detailed brand information"""