Find & Replace in Documents API
Bulk find and replace across many DOCX files, with regex.
Environment
| Environment | Base URL |
|---|---|
| Production | https://api.sadafiles.com/v1 |
There is one environment and no sandbox, so every request here is real and counts toward your limits.
Request
POSThttps://api.sadafiles.com/v1/tools/docx-find-replace
- Content type
- multipart/form-data
- Auth
- X-API-Key with tools:run
- Accepts
- docx
- Files per request
- 1 to 500
- Largest file
- 2 GB
- Job timeout
- 300 s
- Rate weight
- 2 units
Parameters
Send these as a JSON string in the options form field. Anything else is rejected.
| Name | Type | Default | Allowed |
|---|---|---|---|
find | string | — | — |
replace | string | — | — |
regex | boolean | false | — |
matchCase | boolean | false | — |
wholeWord | boolean | false | — |
scopeAll includes headers, footers, footnotes and comments | string | all | all, body |
Response
| Status | Body | When |
|---|---|---|
201 | docx | The run finished within 60 seconds |
202 | Job summary JSON | Still running; poll the job |
4xx, 5xx | Error JSON | See error codes |
A file response carries X-Sada-Job and X-Sada-Expires-At. For long work, post to /v1/tools/docx-find-replace/jobs instead. See jobs and webhooks.
Also runs on the device
In the web tool and apps, Find & Replace in Documents can run locally with no upload. The API always processes on the server.
Try it yourself!
Pick a file, set the options and run a real request with your key. The code follows your changes.