Stream a snapshot file as raw bytes (binary-safe, uncapped)

GET

/workspaces/{id}/snapshot/download/{path}

const url = 'https://your-org.evershell.ai/v1/workspaces/example/snapshot/download/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://your-org.evershell.ai/v1/workspaces/example/snapshot/download/example \
  --header 'Authorization: Bearer <token>'

Permissions: workspace:read or workspace:read:own (creator-match on :own).

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

path

required

string

Responses

200

Raw file bytes from the snapshot tar. Content-Disposition: attachment is set.

application/octet-stream

string format: binary

404

Resource not found in the caller’s org

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}