For AI agents: an index of this documentation is at https://developer.rippling.com/llms.txt. Public pages have a Markdown version at the same URL with .md added.

Skip to main content
API

Create a presigned staged upload batch

POST
/sites/upload-batches/presign/

Use with AI:Rippling AI ChatGPT Claude Cursor

Create a presigned staged upload batch

POST
/sites/upload-batches/presign/

Get a presigned staged upload. This is step 1 of create, update (bundle replace), and file-operations put flows.

  1. Call this endpoint with file_intents (client_ref can be any unique id; file_name is the asset basename).
  2. Upload bytes to S3 with a multipart POST to files[].upload_url (no Rippling auth). Include every key in files[].upload_fields, then a final file part with the binary.
  3. Pass files[].file_id to create, update, or file-operations — not upload_batch_id.

Required Scopes

  • sites.read-write

Request

Body
    file_intents object[]required
    Non-empty array of file upload intents to stage with presigned S3 upload URLs.
      Array [
      client_ref stringrequired

      Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.

      file_name stringrequired

      File name with extension (e.g. site.zip). Used to derive Content-Type and create/PATCH asset type.

      ]

Responses​

Successful response
Schema
    upload_batch_id string

    Identifier for the staged upload batch.

    files object[]
    Staged files created by the upload batch.
      Array [
      client_ref string

      Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.

      file_id string

      Staged upload identifier for use in create, update, or file operations after uploading bytes to S3. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.

      file_name string

      Staged file name from the presign file_name intent.

      status string

      Upload status. Returns awaiting_upload after presign until the file is uploaded to S3. After the object exists in S3, status becomes active on first use. Attach does not consume the staged upload; it is removed after expiry.

      upload_url string

      Presigned S3 POST URL for uploading the file bytes.

      upload_fields object

      Form fields required for the S3 POST (send these before the file part).

      ]
Loading...