For the complete documentation index, see llms.txt. This page is also available as Markdown.

POST /images/media/{savedMediaId}/archive

Archive a media library item. Idempotent — archiving an already archived item succeeds.

Remove a generated image (or other item you created) from the workspace media library without deleting the underlying file. Existing URLs continue to work.

Archive a media item

post

Removes an item you created (such as a generated image) from the workspace media library. The operation is idempotent - archiving an already archived item succeeds. The underlying file is not deleted: existing URLs continue to work.

Authorizations
X-API-KEYstringRequired

API key for authentication

Path parameters
savedMediaIdstringRequired

The media library identifier of the item to archive, as returned in image.savedMediaId by the image generation status endpoint

Example: def456uvw
Responses
200

Item archived successfully

application/json
savedMediaIdstringRequired

The media library identifier of the archived item

Example: def456uvw
archivedbooleanRequired

Confirmation that the item is archived

Example: true
post/v1.0/images/media/{savedMediaId}/archive
POST /v1.0/images/media/{savedMediaId}/archive HTTP/1.1
Host: public-api.gamma.app
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "savedMediaId": "def456uvw",
  "archived": true
}

Pass the savedMediaId from image.savedMediaId on a completed GET /images/{id} response. Archiving is idempotent — repeating the request on an already archived item returns 200 with "archived": true.

Last updated

Was this helpful?