Download a workspace page attachment

GET/api/v1/workspaces/{workspace_slug}/pages/{page_id}/attachments/{attachment_id}/download/

Validate access and receive a 302 redirect to a temporary presigned download URL. An attachment that has not been confirmed as uploaded returns 400.

Path Parameters

workspace_slug:requiredstring

The workspace's unique slug.

page_id:requiredstring

The workspace page UUID.

attachment_id:requiredstring

The attachment asset UUID.

Scopes

read or wiki.pages:read

Download an attachment

download_url="$(
  curl --fail --silent --show-error --dump-header - --output /dev/null \
    "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/attachments/attachment-uuid/download/" \
    -H "X-API-Key: $PLANE_API_KEY" \
    | sed -n 's/^Location: \(https:\/\/.*\)\r$/\1/p'
)"
test -n "$download_url"
curl --fail --location "$download_url" --output diagram.png

from urllib.parse import urlparse

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/attachments/attachment-uuid/download/",
    headers={"X-API-Key": "your-api-key"},
    allow_redirects=False,
)
response.raise_for_status()
download_url = response.headers["Location"]
if urlparse(download_url).scheme != "https":
    raise ValueError("Expected an HTTPS download URL")

with requests.get(download_url, stream=True) as download:
    download.raise_for_status()
    with open("diagram.png", "wb") as output:
        for chunk in download.iter_content(chunk_size=8192):
            output.write(chunk)

// Run this example server-side. Browser apps must call your backend to keep the API key secret.
import { writeFile } from "node:fs/promises";

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/attachments/attachment-uuid/download/",
  { headers: { "X-API-Key": process.env.PLANE_API_KEY }, redirect: "manual" },
);
if (response.status !== 302) throw new Error(`Expected a redirect, received ${response.status}`);

const downloadUrl = new URL(response.headers.get("location"));
if (downloadUrl.protocol !== "https:") throw new Error("Expected an HTTPS download URL");

const download = await fetch(downloadUrl);
if (!download.ok) throw new Error(`Download failed with ${download.status}`);
await writeFile("diagram.png", Buffer.from(await download.arrayBuffer()));

Response302

The Location header contains the temporary presigned download URL.