Skip to main content
GET
/
images
/
edits
/
{edit_id}
Retrieve an image edit's status and results
curl --request GET \
  --url https://api.samsa.ai/public/v1/images/edits/{edit_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "credits_used": 5,
  "images": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "thumbnail_url": "<string>",
      "width": 123,
      "height": 123,
      "seed": 123
    }
  ],
  "error": "<string>"
}
Retrieve the status of a Magic Edit job. While it is pending or processing, keep polling; once completed, the response carries the edited images, each with a presigned url valid for 24 hours. Only edit jobs your organization created are visible; any other id returns 404 not_found.
Pass a webhook_url on the original edit request to receive a signed callback instead of polling. See Webhooks.

Authorizations

​
Authorization
string
header
required

Organization API key as a bearer token: Authorization: Bearer samsa_sk_....

Headers

​
authorization
string | null

Path Parameters

​
edit_id
string<uuid>
required

Response

Successful Response

GET /images/edits/{id} body — same contract as image generation.

Both are backed by image_generation_tasks; a distinct name for the docs.

​
id
string<uuid>
required
​
status
enum<string>
required

pending, processing, completed, failed, or cancelled.

Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"completed"

​
created_at
string<date-time>
required

When the job was submitted.

​
credits_used
integer | null

Credits charged for this job.

Example:

5

​
images
PublicImageAsset · object[]

Produced images (presigned URLs); empty until completed.

​
error
string | null

Failure detail when status is failed; otherwise null.