/api/v1/files/{file_id}/copy-web-content/

Clone a WEB file's S3 folder content from a source file into this
(target) file. The standard URL-download + extract pipeline can't
handle WEB content because it's a folder of files, not a single zip.

Body — exactly one of:

  • {"source_file_id": "<source_id>"} — server-side S3-to-S3 copy
    using the source File row (must be in the same DB / same region).
  • {"signed_urls": [{"url": ..., "target_relative_path": ...}, ...]}
    — HTTP-download each signed URL into the target's S3 path.
    Used for cross-DB / cross-region promotions.

Async — returns 202 immediately. The target file's status transitions
from PENDING to VIEWABLE (or FAILED) once the background copy finishes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A unique value identifying this file.

Body Params
string
length between 1 and 255
string
enum
  • automatic - Automatic
  • mandatory - Mandatory
  • ondemand - On Demand
Allowed:
string
enum
  • public - Public
  • restricted - Restricted
  • personal - Personal
Allowed:
permissions
object
metadata
object

Free-form metadata object. A multipart/form-data request sends it as a JSON-encoded string. A write replaces the whole object: only the pitcher namespace and aiAnalysis are kept when the payload leaves them out, so send back every other key you want to keep. That includes pptx_data, the PPTX's extracted slide data, which a conversion needs: once a write drops it, turning conversion on is refused. PPTX-to-Sections conversion is controlled by three keys that work as a set: pitcher_auto_convert_to_sections: true is the only one that starts a conversion, either on an upload that carries PPTX content, or when a later metadata write turns it on for a viewable PPTX (the write keeps the file's extracted pptx_data, and is refused with the reason when the file cannot be converted yet). pitcher_auto_convert_include_sections (name the section groups after the PPTX's own sections) and pitcher_auto_convert_use_scribble_pdfjs only shape that conversion and do nothing on their own. Progress is reported in pitcher_sections_conversion_status.

app_metadata
object
tags
array of strings
tags
date-time | null
date-time | null
string
length ≥ 1
integer | null
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json