Node.js SDKResources
Convert
Node.js SDK - Document conversion resource
Convert
Resource for converting documents to structured data using OCR. Access via client.convert.
Methods
run(params, options?)
Creates a synchronous conversion request. The API processes the document and returns the result.
const status = await client.convert.run({
documentTypeCode: 'invoice',
url: 'https://example.com/invoice.pdf',
});
console.log(status.conversion_id);
console.log(status.status); // 'SUCCESS' | 'ERROR' | 'ENQUEUED' | 'PROCESSING'
console.log(status.data); // extracted data (on success)Parameters: ConvertParams
Returns: Promise<ConversionStatus>
runAsync(params, options?)
Creates an asynchronous conversion request. Returns a status object with a .wait() method for polling.
import fs from 'fs';
const status = await client.convert.runAsync({
documentTypeCode: 'invoice',
file: fs.readFileSync('invoice.pdf'),
});
// Poll until completion
const result = await status.wait();
console.log(result.data); // extracted dataParameters: ConvertParams
Returns: Promise<ConversionStatus & { wait(): Promise<ConversionStatus> }>
getStatus(conversionId, options?)
Retrieves the current status of a conversion operation.
const status = await client.convert.getStatus('conv_abc123');Parameters: conversionId: string
Returns: Promise<ConversionStatus>
Raw Responses
Access raw HTTP response details via withRawResponse:
const raw = await client.convert.withRawResponse.run({
documentTypeCode: 'invoice',
url: 'https://example.com/invoice.pdf',
});
console.log(raw.statusCode); // 200
console.log(raw.headers); // Response headers
const data = await raw.parse(); // Parsed body