Skip to content

docs: document optimized_url in the host-image and upload skills #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
facundofarias merged 1 commit into from
Oct 29, 2026
Merged

docs: document optimized_url in the host-image and upload skills #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude-plugin/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "pixelvault",
"description": "Upload, manage, and serve images via PixelVault — agent-first image hosting for developers and AI coding agents.",
"version": "1.6.0",
"version": "1.7.0",
"author": {
"name": "PixelVault",
"email": "hello@pixelvault.dev"
Expand Down
3 changes: 3 additions & 0 deletions skills/pixelvault-host-image/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ The `X-PixelVault-Client` header only tells PixelVault which skill made the call
| Link lifetime | 30 days (`"temporary": true`) | Permanent |
| Import from a URL | No | Yes |
| Private signed links | No | Yes |
| Smaller WebP/AVIF link (`data.optimized_url`) | No | Yes (public raster images) |

With a key, public raster uploads (PNG, JPEG, WebP, AVIF) also return `data.optimized_url`: the same image as WebP or AVIF, usually far smaller. Prefer it when the link goes into a page, README or email, and keep `data.url` as the original. It is absent for SVG, GIF and private uploads, so fall back to `data.url`: `jq -r '.data.optimized_url // .data.url'`.

Keyless is the default. Do not ask the user to sign up before the first upload.
If the user wants links that never expire, tell them to create a free account at
Expand Down
3 changes: 3 additions & 0 deletions skills/pixelvault-upload/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ pixelvault upload screenshot.png
pixelvault upload diagram.svg --json
# → { "id": "img_xyz", "url": "https://...", "size": 12400, ... }

# Public raster uploads also include optimized_url (WebP/AVIF, usually much smaller) in --json output;
# prefer it over url when embedding. Absent for SVG, GIF and private uploads.

# Bulk upload
pixelvault upload ./assets/*.png --folder assets

Expand Down