Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
inputText
string

Text

file
string

File (read as raw bytes)

sourceEncoding
enum<string>

File is currently encoded as

Available options:
utf-8,
utf-16le,
utf-16be,
ascii,
iso-8859-1,
windows-1252,
iso-8859-15,
iso-8859-2,
windows-1250,
iso-8859-5,
windows-1251,
koi8-r,
koi8-u,
ibm866,
iso-8859-7,
windows-1253,
windows-1254,
iso-8859-8,
windows-1255,
windows-1256,
windows-1257,
windows-1258,
windows-874,
macintosh,
shift_jis,
euc-jp,
gbk,
big5,
euc-kr
targetEncoding
enum<string>

Convert to

Available options:
utf-8,
utf-16le,
utf-16be,
ascii,
iso-8859-1,
windows-1252,
iso-8859-15,
iso-8859-2,
windows-1250,
iso-8859-5,
windows-1251,
koi8-r,
koi8-u,
ibm866,
iso-8859-7,
windows-1253,
windows-1254,
iso-8859-8,
windows-1255,
windows-1256,
windows-1257,
windows-1258,
windows-874,
macintosh,
shift_jis,
euc-jp,
gbk,
big5,
euc-kr
addBom
boolean

Add a byte order mark (UTF-8 / UTF-16 only)

strict
boolean

Fail if a character can't be represented (otherwise it becomes ?)

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.