View as Markdown
Zip Archive API icon

Zip Archive API ACTION

Compress Files

Compress files provided through URLs into a zip folder. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zip Archive API account once, then configure and run Compress Files from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "zip_archive_api-compress-files",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zip_archive_api: { authProvisionId: "apn_xxxxxxx" },
    archiveName: "Archive Name",
    compressionLevel: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Compress Files inputs
Property Type Description
archiveName Archive Name string
Compressed archive name
Required
compressionLevel Compression Level integer
Archive compression level. Value range: 1-9
Optional
password Password string
The compressed ZIP archive password
Optional
files File Paths or URLs string[]
The files to upload. For each entry, provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.txt)
Required
syncDir SyncDir dir
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
zip_archive_api-compress-files
Version
1.0.2
App
Zip Archive API
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes