Extract Archive
curl --request POST \
--url https://api.app.shinzo.ai/v1/agent/{agentId}/filesystem/archives/extract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archivePath": "<string>",
"outputPath": "<string>",
"overwrite": true
}
'Agent Filesystem
Extract Archive
Extract a compressed archive in an agent’s workspace.
POST
/
v1
/
agent
/
{agentId}
/
filesystem
/
archives
/
extract
Extract Archive
curl --request POST \
--url https://api.app.shinzo.ai/v1/agent/{agentId}/filesystem/archives/extract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"archivePath": "<string>",
"outputPath": "<string>",
"overwrite": true
}
'Authentication
Requires JWT token or Platform API key.string
required
Agent UUID
string
required
Path to the archive file in the workspace
string
required
Directory to extract the archive contents into
boolean
Overwrite existing files during extraction
Example Request
curl -X POST "https://api.app.shinzo.ai/v1/agent/agt_abc123/filesystem/archives/extract" \
-H "Authorization: Bearer <jwt_token>" \
-H "Content-Type: application/json" \
-d '{
"archive_path": "/workspace/backup.tar.gz",
"destination": "/workspace/restored",
"overwrite": true
}'
Response
{
"destination": "/workspace/restored",
"files_extracted": 12
}
Response Fields
| Field | Type | Description |
|---|---|---|
destination | string | Directory where the archive was extracted |
files_extracted | number | Total number of files extracted |
Status Codes
| Code | Description |
|---|---|
200 | Archive extracted successfully |
400 | Invalid request body or unsupported archive format |
401 | Invalid authentication |
403 | Access denied |
404 | Agent or archive file not found |