ReWords.AI API

Get an edit and its results

GET
/edits/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Send Authorization: Bearer rw_live_.... Create up to 5 keys at https://rewords.ai/developers/keys/ once your account has API balance.

Path Parameters

id*string

Response Body

The edit.

application/json
  1. response
id*string
status*string
Value in"queued""processing""succeeded""failed"
queue_position?integer

While queued: jobs waiting ahead of this one. Jobs already running are not counted, so 0 means next to start.

estimated_seconds?integer

While queued, our estimate of the seconds until this job will finish.

results?
replacements?array<>

Replacements as applied: one item per line that is changed, with the box we located and the line's full text in from and to. Items keep the order of your request; a replacement that matched several lines becomes several items, top to bottom.

charged?integer

Edits charged (1 when A or B succeeded, otherwise 0).

balance?integer

Edits left on the account when this response was made — the same as edits_remaining in GET /account (edits reserved for unfinished jobs, including this one, are already taken off).

error?

Present when failed. code is one of content_blocked, ai_generation_failed, timeout, upstream_failed or invalid_image (the file passed the upload checks but could not be decoded).

created_at?string
Formatdate-time
completed_at?string
Formatdate-time
Example Request
curl -X GET 'https://api.rewords.ai/v1/edits/edit_9f8e7d' \  -H 'Authorization: Bearer rw_live_your_key'
Example Response
{  "id": "edit_9f8e7d",  "status": "succeeded",  "results": {    "A": {      "status": "succeeded",      "url": "https://img.rewords.ai/api/edit_9f8e7d_a.jpg"    },    "B": {      "status": "succeeded",      "url": "https://img.rewords.ai/api/edit_9f8e7d_b.jpg"    },    "C": {      "status": "skipped",      "reason": "aspect_ratio_unsupported"    }  },  "replacements": [    {      "from": "SALE",      "to": "HOT DEAL",      "box": [        120,        80,        300,        60      ]    }  ],  "charged": 1,  "balance": 299,  "created_at": "2026-11-04T10:00:00Z",  "completed_at": "2026-11-04T10:01:12Z"}

Replace text in an image POST

Queues an edit and returns immediately. Pass `callback_url`, or poll `GET /edits/{id}`: every 5 seconds while the job is `processing` or `queued` with `queue_position` 0, and every 30 seconds while it is further back in the queue. One edit is reserved now and refunded automatically if neither A nor B succeeds. If a replacement has no `box`, we read the image before answering, so this call usually takes 5–20 seconds (allow 90) and can return `422 text_not_found`.

Get balances and limits GET

다음 페이지