Redact a batch of records

Redacts up to 100 records, keeping their order and ids. Records without an id are numbered rec-<n>. Each record is metered, as corpus.redact.

POST/v1/corpus/redact

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

recordsCorpusRecord[]required

min items 1 · max items 100

Show properties

Array of CorpusRecord

idstring

Optional; defaults to rec-<n>.

textstringrequired

Responses

200

Redacted records

recordsobject[]required

Show properties

Array of object

idstringrequired

redacted_textstringrequired

findingsPiiFinding[]required

Show properties

Array of PiiFinding

entity_typestringrequired

startintegerrequired

Byte offset of the first byte of the span.

endintegerrequired

Byte offset one past the last byte.

scorenumberrequired

0 to 1.

findings_totalintegerrequired

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

502

Upstream service (arXiv, YouTube, web page) failed

string

503

The backing service is not configured or is busy

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.webfold.ai/v1/corpus/redact' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "records": [
    {
      "id": "string",
      "text": "string"
    }
  ]
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/corpus/redact",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"records\": [\n    {\n      \"id\": \"string\",\n      \"text\": \"string\"\n    }\n  ]\n}",
)

const response = await fetch("https://api.webfold.ai/v1/corpus/redact", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"records\": [\n    {\n      \"id\": \"string\",\n      \"text\": \"string\"\n    }\n  ]\n}"
});

Response

{
  "records": [
    {
      "id": "string",
      "redacted_text": "string",
      "findings": [
        {
          "entity_type": "EMAIL",
          "start": 0,
          "end": 0,
          "score": 0
        }
      ]
    }
  ],
  "findings_total": 0
}

"string"

"string"

"string"

"string"

"string"