Skip to main content
xbox xbl achievement-image uploads PNG images for a title’s achievements and reads back the images registered for it. --scid takes the title’s service configuration identifier (SCID). upload returns an iconImageId to put in the title’s achievement configuration.

Options

Examples

Upload an image:
Pass the assetId that upload returns to verify the image, and to download it and its thumbnail into achievement-images/<assetId>/:
List every image registered for the SCID, and download them all:

Output

upload and get return one image object, and list returns an array of them, or []. Each object has the service’s fields, such as assetId, cdnUrl, thumbnailCdnUrl, widthInPixels, and heightInPixels, plus iconImageId, which equals assetId:
Copy iconImageId into the title’s achievements2017.xml configuration:
Their tables show ASSET ID, CDN FILENAME, WIDTH, HEIGHT, IMAGE TYPE, and PUBLIC. Use JSON for the full CDN URLs and other fields. download returns a manifest: an object with assetId, destination, imagePath, thumbnailPath, imageBytes, and thumbnailBytes for --asset-id, or an array of them for --all. Its table shows ASSET ID and DESTINATION. Files with the same names are replaced, and other files in the asset folder are kept. If a download fails, that asset’s existing files are left as they were; with --all, folders already downloaded stay. A failed command exits 1 and writes the error to stderr. When the service rejects the image, the error lists each validation message.

Production safety and upload recovery

Every upload registers a new image, even of the same file, and the CLI never retries one. If upload reports Upload outcome unknown, the image might have been registered: run the get or list command it prints on stderr before uploading again, and use the existing asset ID if you find your image. Ctrl+C before the registration is sent registers nothing. To inspect the full image and thumbnail, download them:
upload doesn’t ask before it registers an image, and --confirm doesn’t apply to it. See Safety and destructive operations.
Last modified on November 18, 2026