v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB

File

Poll File Analysis

Monitor the File Analysis operation and receive the analysis results.

File analysis results will be available for 24 hours after generation.

get/files/analysis/{operationId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Response

status'converting' | 'analysis' | 'costCalculation' | 'completed' | 'error' required

The status of the file analysis operation.

converting - The files are being converted for analysis.<br> analysis - Extracting the word count from the files.<br> costEstimation - Estimating the cost.<br> completed - The file analysis is completed.<br> error - The file analysis was unsuccessful. See the errorMessage field for more details.

wordCountinteger

<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The total word count of the files.</div>

errorMessagestring

The cause of the error when the status is error.