Create Archive

curl --request POST \
  --url https://api.app.shinzo.ai/v1/agent/{agentId}/filesystem/archives \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paths": [
    {}
  ],
  "outputPath": "<string>",
  "format": "<string>",
  "compressionLevel": 123
}
'

POST

agent

{agentId}

filesystem

Authentication

Requires JWT token or Platform API key.

string

required

Agent UUID

array

required

List of file or directory paths to include in the archive

string

required

Destination path for the archive file

string

Archive format: zip, tar, tar.gz, or tar.bz2

number

Compression level (0-9, where 9 is maximum compression)

Example Request

curl -X POST "https://api.app.shinzo.ai/v1/agent/agt_abc123/filesystem/archives" \
  -H "Authorization: Bearer <jwt_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "paths": [
      "/workspace/src",
      "/workspace/config.json"
    ],
    "output_path": "/workspace/backup.tar.gz",
    "format": "tar.gz",
    "compression_level": 6
  }'

Response

{
  "path": "/workspace/backup.tar.gz",
  "size": 4096,
  "format": "tar.gz"
}

Response Fields

Field	Type	Description
`path`	string	Absolute path of the created archive
`size`	number	Archive size in bytes
`format`	string	Archive format used

Status Codes

Code	Description
`201`	Archive created successfully
`400`	Invalid request body or paths
`401`	Invalid authentication
`403`	Access denied
`404`	Agent or source paths not found

Overview

Authentication

AI Agents

Agent Messaging

Agent Schedules & Triggers

Agent Channels

Agent Filesystem

MCP Servers

Spotlight

Tokens

Provider Keys

Telemetry

Create Archive

Authentication

Example Request

Response

Response Fields

Status Codes

​Authentication

​Example Request

​Response

​Response Fields

​Status Codes

Authentication

Example Request

Response

Response Fields

Status Codes