> For the complete documentation index, see [llms.txt](https://developers.gamma.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.gamma.app/agent-gamma-5/get-edit-status.md).

# GET /agent/edits/{editId}

Poll an agent edit job until status is completed or failed.

Poll an edit job started with [POST /agent/gammas/{gammaId}/edits](/agent-gamma-5/edit-gamma.md) until `status` is `completed` or `failed`: a completed response includes `result.summary`, a failed one includes `error`, and both carry the gamma URL and, when the lookups succeed, `credits.deducted` / `credits.remaining`.

## Get edit status

> Retrieves the current status of an edit job. Poll this endpoint until \`status\` is "completed" or "failed".

```json
{"openapi":"3.0.0","info":{"title":"Gamma Public API","version":"1.0"},"tags":[{"name":"public-api","description":"Public API endpoints for external integrations"}],"servers":[{"url":"https://public-api.gamma.app","description":"Production"}],"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"API key for authentication"}},"schemas":{"PendingEditStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["pending"]},"editId":{"type":"string","description":"Unique ID for the edit job."},"gammaId":{"type":"string","description":"File ID of the Gamma being edited."},"gammaUrl":{"type":"string","description":"URL to the Gamma being edited"},"pageId":{"type":"string","description":"ID of the page the edit applies to."},"updatedTime":{"type":"string","description":"ISO-8601 timestamp of the last state change."}},"required":["status","editId","gammaId","gammaUrl","pageId","updatedTime"]},"CompletedEditStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["completed"]},"editId":{"type":"string","description":"Unique ID for the edit job."},"gammaId":{"type":"string","description":"File ID of the edited Gamma."},"gammaUrl":{"type":"string","description":"URL to the Gamma being edited"},"pageId":{"type":"string","description":"ID of the page the edit applies to."},"result":{"$ref":"#/components/schemas/EditResult"},"updatedTime":{"type":"string","description":"ISO-8601 timestamp of the last state change."},"credits":{"description":"Credit accounting for this job. Present on every completed or failed\nresponse; each member is best-effort and omitted when unknown.","allOf":[{"$ref":"#/components/schemas/AgentCreditsResponse"}]}},"required":["status","editId","gammaId","gammaUrl","pageId","result","updatedTime","credits"]},"EditResult":{"type":"object","properties":{"summary":{"type":"string","description":"Agent-written summary of the applied changes."}},"required":["summary"]},"AgentCreditsResponse":{"type":"object","properties":{"deducted":{"type":"number","description":"Credits recorded as debited from your balance for this job so far: the\nagent's model and tool spend settled from its ledger plus image generation\ncharged as it ran. Actual amounts removed, not list prices — spend that\ncould not be charged because the balance was empty is not included. It can\nstill grow if a late settlement lands after completion, and accounting is\nbest-effort: a failed record write can leave it low, and `0` means no\ncharge was recorded. Omitted when the job's charge record cannot be\nlooked up at all."},"remaining":{"type":"number","description":"Credits currently available to the authenticated user in this workspace,\nread when this status was served. Not what this job cost: other jobs,\npurchases and refills move it between polls. Omitted if the balance\nlookup fails."}}},"FailedEditStatusResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failed"]},"editId":{"type":"string","description":"Unique ID for the edit job."},"gammaId":{"type":"string","description":"File ID of the Gamma being edited."},"gammaUrl":{"type":"string","description":"URL to the Gamma being edited"},"pageId":{"type":"string","description":"ID of the page the edit applies to."},"error":{"$ref":"#/components/schemas/EditError"},"updatedTime":{"type":"string","description":"ISO-8601 timestamp of the last state change."},"credits":{"description":"Credit accounting for this job. Present on every completed or failed\nresponse; each member is best-effort and omitted when unknown.","allOf":[{"$ref":"#/components/schemas/AgentCreditsResponse"}]}},"required":["status","editId","gammaId","gammaUrl","pageId","error","updatedTime","credits"]},"EditError":{"type":"object","properties":{"reason":{"description":"Machine-readable failure reason. A failed edit may have been partially\napplied, so inspect the Gamma before retrying.","enum":["access_revoked","edit_failed","insufficient_credits","target_not_found","timeout","unavailable","unsupported_target"],"type":"string"},"message":{"type":"string","description":"Human-readable explanation."},"statusCode":{"type":"number","description":"HTTP-style status code for the failure reason."}},"required":["reason","message","statusCode"]}}},"paths":{"/v1.0/agent/edits/{editId}":{"get":{"description":"Retrieves the current status of an edit job. Poll this endpoint until `status` is \"completed\" or \"failed\".","operationId":"getEditStatus","parameters":[{"name":"editId","required":true,"in":"path","description":"The edit ID returned by `POST /v1.0/agent/gammas/{gammaId}/edits`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Edit status retrieved successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PendingEditStatusResponse"},{"$ref":"#/components/schemas/CompletedEditStatusResponse"},{"$ref":"#/components/schemas/FailedEditStatusResponse"}]}}}},"400":{"description":"Invalid request parameters"},"401":{"description":"Invalid or missing API key"},"404":{"description":"Edit not found"},"429":{"description":"Rate limit exceeded"}},"summary":"Get edit status","tags":["public-api"]}}}}
```

{% hint style="info" %}
For polling patterns and rate limit headers, see [Poll for results](/guides/async-patterns-and-polling.md).
{% endhint %}

## Related

* [POST /agent/gammas/{gammaId}/edits](/agent-gamma-5/edit-gamma.md) to start an edit
* [Poll for results](/guides/async-patterns-and-polling.md) for complete polling implementations
* [GET /gammas/{gammaId}](/management/get-gamma.md) to verify the Gamma after a successful edit


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.gamma.app/agent-gamma-5/get-edit-status.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.