ConvertApi Logo

RTF to TXT API

The API for converting Word RTF documents to TXT files. Easily extract text from Word documents.

API Request:
Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL File File
Required

File File to be converted. Value can be URL or file content.

Show all
Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all
Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all
Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

Show all
Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

Show all
Copy parameter's URL DocumentPassword Document Password
Optional

String Sets the password to open protected documents.

Show all
Copy parameter's URL Substitutions Enable substitutions
Optional

Bool Replace similar symbols with their counterparts in a text file, such as a copyright symbol with (c).

Default: False

Show all
Copy parameter's URL LineBreaks Insert line breaks
Optional

Bool Inserts line breaks at the end of each line of text.

Default: True

Show all
Copy parameter's URL TextEncoding Text Encoding
Optional

Collection Specifies what encoding the parser should use when converting text files.

Default: auto

Values: auto, ascii, utf-7, utf-8, iso-8859-1, iso-8859-2, iso-8859-6, iso-8859-15, windows-1252, arabicasmo, baltic, centraleuropean, cyrillic, europa, extalphalowercase, greek, hebrew, hzgbsimplifiedchinese, german, japaneseshiftjis, koi8-r, koi8-u, korean, thai, turkish, unicodebigendian, unicodelittleendian, vietnamese

Show all
Copy parameter's URL EndLineChar End Line Character
Optional

Collection Set end of line character. The character which will be used to break lines.

Default: crlf

Values: crlf, cr, lfcr, lf

Show all
Copy parameter's URL SaveFormat Save Format
Optional

Collection Specifies the format to use when saving a document.

Default: unicodetext

Values: wintext, wintextlb, dostext, dostextlb, unicodetext

Show all

Developer mode

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example