Skip to main content
Packs are reusable image collections used by slideshow generation.

​
Scope Rules

  • Workspace keys can mutate only packs in their workspace.
  • Personal keys can mutate only personal packs (workspace_id IS NULL).
  • Public packs are readable (when included) but not mutable unless owned in scope.

​
Endpoint Index

OperationEndpointDocs
List packsGET /api/partner/v1/packsList Packs
Get packGET /api/partner/v1/packs/{packId}Get Pack
Create packPOST /api/partner/v1/packsCreate Pack
Update packPATCH /api/partner/v1/packs/{packId}Update Pack
Delete packDELETE /api/partner/v1/packs/{packId}Delete Pack
Add image by URLPOST /api/partner/v1/packs/{packId}/imagesAdd Pack Image
Delete imageDELETE /api/partner/v1/packs/{packId}/images/{imageId}Delete Pack Image

​
Choosing Image Input Mode

Use this decision rule when adding pack images:
  1. If you already have a public image URL, call Add Pack Image directly.
  2. If you only have file bytes, call Upload File first, then call Add Pack Image with the returned url.
  3. Add Pack Image stores a URL reference in the pack. It does not fetch or re-host the file at add time.

​
Typical Flows

​
Flow A: Existing image URLs

  1. Create a pack.
  2. Add images by URL (POST /api/partner/v1/packs/{packId}/images).
  3. Use the pack ID in slideshow generation (pack_id / pack_assignments).

​
Flow B: Local files / raw bytes

  1. Create a pack.
  2. Call POST /api/partner/v1/files to get uploadUrl + url.
  3. Upload bytes with PUT uploadUrl.
  4. Call POST /api/partner/v1/packs/{packId}/images with image_url = url.
  5. Use the pack ID in slideshow generation (pack_id / pack_assignments).