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
Article

SiteStagedUploadBatchResponse

Use with AI:Rippling AI ChatGPT Claude Cursor

SiteStagedUploadBatchResponse

    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).

  • ]