Docs

Developer documentation for Change Text in Image AI. Jump to Auth, Detect, Edit, or Errors.

Auth

Create one API key per account from the dashboard when your plan includes API access. Send it on every request:

Authorization: Bearer YOUR_API_KEY

Keys share the same credit pool as the web editor. Rotate a key from the dashboard if it is exposed.

Detect

Optional auto-detect returns candidate boxes and OCR strings. Manual box selection on the web UI costs nothing. When detect uses a hosted OCR model it may cost 0 or 1 credit depending on configuration.

curl -X POST https://changetextinimageai.com/api/v1/detect \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "image=@poster.png"

Edit

Replace or remove text inside a box. A successful job costs 1–2 credits. Result URLs expire after 24 hours.

  1. Authenticate. Send Authorization: Bearer <key> on every request. Create one API key per account from the dashboard when API access is enabled on your plan.
  2. Call Edit. POST /api/v1/edit with image (URL or multipart), box [x,y,w,h], new_text, and mode replace or remove. A successful job costs 1–2 credits.
  3. Download the result. Use the returned result URL within 24 hours. Outputs are deleted after the retention window.
curl -X POST https://changetextinimageai.com/api/v1/edit \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "image=@poster.png" \
  -F "box=[120,80,240,48]" \
  -F "new_text=Sale $12" \
  -F "mode=replace"

Use mode=remove and empty new_text to erase text and fill background.

Errors

CodeMeaning
401Missing or invalid API key.
402Not enough credits.
413Image too large (over size or megapixel policy).
429Rate limited (30/min/key) or daily budget exhausted.
422Safety reject or invalid parameters.
503Generation is not open yet on this deployment.

Failed jobs that never produce a result do not charge user credits. See also API overview.