extractFileTextWithHttpInfo method
Extract text content from a PDF (or other supported file).
Note: This method returns the HTTP Response.
Parameters:
-
String id (required): File id.
-
String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with
provider. If omitted on a list endpoint the call fans out across every connected account. -
String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
-
int pageStart:
-
int pageEnd:
-
int maxChars: Truncation limit; sets
truncated: truewhen hit.
Implementation
Future<Response> extractFileTextWithHttpInfo(String id, { String? accountId, String? xWorkspaceID, int? pageStart, int? pageEnd, int? maxChars, }) async {
// ignore: prefer_const_declarations
final path = r'/v1/files/{id}/extract-text'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (accountId != null) {
queryParams.addAll(_queryParams('', 'accountId', accountId));
}
if (pageStart != null) {
queryParams.addAll(_queryParams('', 'pageStart', pageStart));
}
if (pageEnd != null) {
queryParams.addAll(_queryParams('', 'pageEnd', pageEnd));
}
if (maxChars != null) {
queryParams.addAll(_queryParams('', 'maxChars', maxChars));
}
if (xWorkspaceID != null) {
headerParams[r'X-Workspace-ID'] = parameterToString(xWorkspaceID);
}
const contentTypes = <String>[];
return apiClient.invokeAPI(
path,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}