Cleanse

Start a cleanse analysis

Starts a new cleanse analysis operation in the background. Progress can be tracked via GET /cleanse/run/{operationId}.

post/cleanse/start-analysis

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/cleanse/start-analysis
  • Auth
    API key in header X-API-Key

Response

Analysis started

operationIdstring
statusstring
messagestring
startedAtUtcstring date-time

Changes

No recorded changes to this operation across all 5 revisions of this API.