POST /gammas/{gammaId}/archive

Archive a Gamma document. Idempotent -- archiving an already archived Gamma succeeds.

Archive a Gamma to remove it from the active workspace without deleting it.

Archive a Gamma

post

Archives a Gamma document. The operation is idempotent - archiving an already archived Gamma succeeds.

Authorizations

X-API-KEYstringRequired

API key for authentication

Path parameters

gammaIdstringRequired

The unique ID of the Gamma to archive

Example: gamma_abc123

Responses

200

Gamma archived successfully

application/json

gammaIdstringRequired

The ID of the archived Gamma

Example: gamma_abc123

archivedbooleanRequired

Confirmation that the Gamma is archived

Example: true

400

Invalid request parameters

401

Invalid or missing API key

403

Access denied - edit permission required

post/v1.0/gammas/{gammaId}/archive

POST /v1.0/gammas/{gammaId}/archive HTTP/1.1
Host: public-api.gamma.app
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "gammaId": "gamma_abc123",
  "archived": true
}

The gammaId must be the file ID returned by the API (e.g. g_l0mf2jvf1fpmi1v), not the slug from the web app URL. If you pass the URL slug (the ID at the end of gamma.app/docs/My-Doc-bc7s74ruzod20f4), the request returns 403 instead of 404.

Example

curl -X POST "https://public-api.gamma.app/v1.0/gammas/$GAMMA_ID/archive" \
  -H "X-API-KEY: $GAMMA_API_KEY"

{
  "gammaId": "g_l0mf2jvf1fpmi1v",
  "archived": true
}

Behavior

• Idempotent. Archiving an already archived Gamma returns 200 with "archived": true.
• No credits deducted. This endpoint does not consume credits.
• Requires edit permission. The API key owner must have edit access, and the Gamma must belong to the API key's workspace.

Finding the gammaId

Poll a completed generation to get the ID:

curl "https://public-api.gamma.app/v1.0/generations/$GENERATION_ID" \
  -H "X-API-KEY: $GAMMA_API_KEY"

The gammaId value in the response (e.g. g_l0mf2jvf1fpmi1v) is what you pass to /archive. The gammaUrl field contains the web app link, but the slug in that URL is not the same ID.

Related

• GET /generations/{id} to retrieve the gammaId from a generation
• Error codes for the 403 response when using a wrong ID