Update file

Updates a file.

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.

Query Params
string
enum
Defaults to base

PDF Annotation Layer to display.

Allowed:
Body Params
string
length between 1 and 255
file
string
length ≥ 1
uri
length ≥ 1
string
enum

Optional content type hint, used only as a fallback when the URL filename's extension is not in the recognized extension-to-type map. Ignored otherwise.

  • ar - AR
  • attch - Attachment
  • audio - Audio
  • font - Font
  • image - Image
  • pdf - PDF
  • video - Video
  • web - Web
boolean
Defaults to false
file
(?:gif|jpg|jpeg|png|svg|webp)$
string
length ≥ 1
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