To convert a word document to PDF using our API Rest is necessary to perform a POST call to the following URL (ENDPOINT):
https://getoutpdf.com/api/convert/document-to-pdf
Our Rest API does not have operations via GET parameters
api_key
Api key generated for your license. You can see your api key lincence document
Word document encoded in base64application/x-www-form-urlencoded
, with the parameters described above.
Or you can send parameters via the JSON format, using the HTML Header application/json
:
{ "api_key": "...", // string, required "document": "..." // string, required }
{ "api_key": "64b5d1054b69e676b9984d8406c5209a6ba78...", "document": "JVBERi0xLjQNJeLjz9MNCjYgMCBvYmo8PC9I..." }
If the operation is successful the response is a JSON with the following structure:
{ "api_key": "...", // string - Api key used for your license "pdf_base64": "...", // string - PDF file encoded in base64 "tokens_used": "...", // integer - Tokens used in operation "tokens_left": "..." // integer - Tokens left }
If an error in sending parameters occurs, the response is a JSON with the following structure:
{ "errors": { "param1": [ // string - Parameter name that generated the error "message" // string - Error description ], "param2": [ "message" ], ... "paramN": [ "message" ] } }
If a operation error occurs, the answer will be a JSON with the following structure:
{ "errors": [ "message1", "message2", ... "messageN" ] }