fynepdf logo
Docs menu

Find what to redact

Say what to hide ("names, emails and account numbers"); code searches the text and the model only plans the search and spots names. Returns every match by page, and a ready redact step that removes them (and proves it). Price: 2 credits + 1 per 2 pages.

POST /v1/ai/redact-find

Request

curl -X POST https://api.fynepdf.com/v1/ai/redact-find \
  -H "Authorization: Bearer $FYNEPDF_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"file_id":"file_01jc8x4m2k9q7r3t5vwy6z","request":"every person's name and phone number"}'

Body

ParameterTypeRequiredWhat it does
file_idstringyes
requeststringyes

Response

Matches.

FieldTypeRequiredWhat it does
object"redaction_matches"yes
matchesarray of objectyes
next_stepobject or nullyes
creditsintegeryes
testboolean

Errors

Errors are problem details (RFC 9457) with a code you can branch on and a request_id for support.