Pax8

Interact with the Pax8 Partner API

Actions100

Library attachments → Download library attachment

AI-generated

Summary

Downloads a library attachment file from the Pax8 API.

Inputs

  • baseUrl — Base URL for the Pax8 API. Defaults to https://api.pax8.com if not specified.
  • attachmentId (required) — The attachment ID path parameter used to identify the specific library attachment to download.
  • download — Must be set to true to download the file. Defaults to true; set to false to retrieve metadata only.

Output shape

Binary file stream or downloadable content when download is true; otherwise attachment metadata.

Authentication is handled via the Pax8 OAuth2 Bearer token (automatically managed by the node). The API endpoint is constructed using the base URL, API version prefix, and the provided attachment ID as a path parameter.

Examples

Example 1: Download a specific library attachment.

Provide the attachmentId; leave download at its default true and baseUrl at default if using the production API.

Links

Discussion