Sign in
downloading

Download Single

Download a single file to S3

Requires permission: download:write

post/download/single

Request body

urlstring uri required

URL to download

s3_keystring nullable

S3 key for the file

wait_until'domcontentloaded' | 'load' | 'networkidle' | 'commit'

When to consider page load complete for web scraping operations

downloader_type'FLEET_ASYNC'

Available downloader types

timeout_msinteger

Timeout in milliseconds

Example request

{
  "downloader_type": "FLEET_ASYNC",
  "url": "https://example.com/file.pdf",
  "wait_until": "load"
}

Response

Successful Response

successboolean required
job_idstring nullable
download_urlstring required
s3_bucketstring required
s3_keystring required
errorstring nullable

Changes

Changed in 3 of the 16 revisions of this API.125

  • 29225d7b3ea412See the full diff
    • ●

      removed the request property s3_bucket

      request-property-removed

    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

  • 350e41758f4111See the full diff
    • ●

      removed the request property timeout

      request-property-removed

    • ○

      added the new optional request property timeout_ms

      new-optional-request-property

  • 707c0eb9cee112See the full diff
    • ▲

      removed the enum value async_fleet of the request property downloader_type

      request-property-enum-value-removed

    • ○

      the downloader_type request property default value changed from async_fleet to FLEET_ASYNC

      request-property-default-value-changed

    • ○

      added the new FLEET_ASYNC enum value to the request property downloader_type

      request-property-enum-value-added