Skip to main content

Documentation Index

Fetch the complete documentation index at: https://pixa.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Share links let you curate a selection of assets into a shareable URL — without moving them out of their collections. Generate or edit images with your agent, organize the results into a share link, and send it to stakeholders.

MCP actions

The share_links tool supports these actions:
ActionDescription
listList all share links
getGet a share link by ID
createCreate a new share link from assets or a collection
updateAdd or remove assets from an existing share link
contentsList the assets included in a share link

From specific assets

Create a share link called "Summer Collection Lookbook" with the three images we just generated.
The agent calls share_links with action: "create", the name, and the list of asset_ids from the most recent results.

From a collection

Create a share link of all images in my "Product Photos" collection.
The agent calls share_links (create) with the collection_id.
When creating a share link, provide either asset_ids or collection_id — not both.
Add or remove assets from an existing share link:
Add this new product shot to the "Summer Collection Lookbook" share link, and remove the old version.
The agent calls share_links (update) with add_asset_ids and remove_asset_ids.

End-to-end workflow

Generate 4 lifestyle photos of these sneakers on a wooden floor, then create a "Sneaker Launch Lookbook" share link with the results.
The agent:
  1. Calls generate_media with the prompt, num_variations: 4, and the product attachment.
  2. Waits for completion via get_job_status (or polls).
  3. Calls share_links (create) with the resulting asset_ids and the share link name.
  4. Returns the shareable URL.
The returned share link URL can be sent directly to reviewers, clients, or team members — they don’t need a Pixa account to view it.

Use cases

Product boards — Collect generated and edited product photos into a shareable link for team review. Campaign lookbooks — Generate brand-consistent images by passing brand_library_id to generate_media, organize them into a share link, and share with creative leads. Client deliverables — Process a batch of assets via a pipeline, then create a share link as the final deliverable.
For more on views and the visual gallery editor, see the Views & Galleries guide.