Skip to content

Docs sync: GITBOOK-1498: byteplus_tos_update #39

@karolispetkevicius-de

Description

@karolispetkevicius-de

@claude

Documentation Change Detected

A documentation change was pushed to the GitBook repository that may require updates to this SDK.

Commit: 61559074ed0d7c762971e8db91fc3e0f1938f31c
Author: Oxylabs
Message: GITBOOK-1498: byteplus_tos_update

Changed documentation paths

scraping-solutions/web-scraper-api/features/result-processing-and-storage/cloud-storage/README.md

Diff

diff --git a/scraping-solutions/web-scraper-api/features/result-processing-and-storage/cloud-storage/README.md b/scraping-solutions/web-scraper-api/features/result-processing-and-storage/cloud-storage/README.md
index a3d97ab..e5f9ff6 100644
--- a/scraping-solutions/web-scraper-api/features/result-processing-and-storage/cloud-storage/README.md
+++ b/scraping-solutions/web-scraper-api/features/result-processing-and-storage/cloud-storage/README.md
@@ -209,9 +209,19 @@ In this case, please contact Alibaba OSS support to increase your OSS rate limit
 
 ## BytePlus TOS
 
-You can upload scraped results directly to a BytePlus Torch Object Storage (TOS) bucket. Please note you you must have your **bucked set up correctly** and have both you **access key** and **secret key** available for cloud storage access.
+You can upload scraped results directly to a BytePlus Torch Object Storage (TOS) bucket.
 
-The example payload below makes Web Scraper API scrape `https://example.com` and put the result on an BytePlus TOS bucket.
+For a successful connection, you will need:
+
+* A correctly configured TOS bucket.
+* Your access key and secret key.
+* An S3-compatible endpoint.
+
+You can find a list of all available S3 endpoints in the official BytePlus [documentation](https://docs.byteplus.com/en/docs/tos/docs-region-and-endpoint).
+
+### Example
+
+The following payload will scrape `https://example.com` and upload the results to your TOS bucket.
 
 ```json
 {
@@ -224,7 +234,7 @@ The example payload below makes Web Scraper API scrape `https://example.com` and
 
 ### Parameters <a href="#docs-internal-guid-dbfc45c7-7fff-9754-b71a-bacb24e2ac54" id="docs-internal-guid-dbfc45c7-7fff-9754-b71a-bacb24e2ac54"></a>
 
-<table><thead><tr><th width="166">Parameter</th><th width="165">Value</th><th>Description</th></tr></thead><tbody><tr><td><code>storage_type</code></td><td>tos</td><td>Specifies BytePlus TOS as the storage provider.</td></tr><tr><td><code>storage_url</code></td><td>String (URL)</td><td>Authenticated URL to your TOS bucket (see format below).</td></tr></tbody></table>
+<table><thead><tr><th width="166">Parameter</th><th width="165">Available values</th><th>Description</th></tr></thead><tbody><tr><td><code>storage_type</code></td><td><code>tos</code></td><td>Specifies BytePlus TOS as the storage provider.</td></tr><tr><td><code>storage_url</code></td><td>URL string</td><td>Authenticated URL to your TOS bucket (see format below).</td></tr></tbody></table>
 
 ### Storage URL Format
 

Instructions

Analyze the documentation diff above and update the Python SDK source code to match.
Follow the guidelines in CLAUDE.md for mapping documentation paths to SDK source files.

After making changes:

  1. Create a new branch named docs-sync/6155907
  2. Commit your changes
  3. Open a pull request with a summary of what changed and why

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs-syncAutomated docs sync

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions