Web Document Builder API

For the interaction with the web document builder service the POST requests are used. The request parameters are entered in JSON format in the request body. The requests are sent to the https://documentserver/docbuilder address where the documentserver is the name of the server with the ONLYOFFICE Document Server installed.

Parameters and their description:

Parameter Description Type
Defines the type of the request to the document builder service: asynchronous or not.
Supported values:
  • true
  • false
When the asynchronous request type is used, the response is formed instantly. In this case to get the result it is necessary to send requests without parameter change until the document generation is finished. The default value is false.
boolean
Defines the request identifier used to unambiguously identify the request. The key is formed on the document builder service side and is returned as the response to the first request. When the asynchronous request is used (the async parameter is set to true) the key is not present in the first request, but must be present in all the following requests which will be send before the generation is complete. When the synchronous request is used (the async parameter is set to false), this parameter is not required. string
Defines the encrypted signature added to the Document Server config in the form of a token. string required by configuration
Defines the absolute URL to the .docbuilder file. string

The .docbuilder file contains the script used to generate the output document file (text document, spreadsheet or presentation), specifies the output file format and name. Once the document generation is ready, the response with the absolute URL to the resulting file will be returned (see below).

Please note, that .docbuilder script file can contain several output files as a result. The URL to them all will be returned in the response to the request once the file generation is finished.

You can find more information about the .docbuilder file syntax here. Please read ONLYOFFICE Document Builder API documentation for the detailed information on what classes and methods are used to generate the documents with the help of .docbuilder files.

{
    "async": true,
    "url": "https://example.com/url-to-example-script.docbuilder"
}

Where the example.com is the name of the server where document storage service are installed. See the How it works section to find out more on Document Server service client-server interactions.

Response format
{
   "key": "af86C7e71Ca8",
   "end": false
}
{
    "async": true,
    "key": "Khirz6zTPdfd7"
}
Response format
{
   "key": "Khirz6zTPdfd7",
   "urls": {
      "SampleText.docx": "https://documentserver/SampleText.docx",
      "SampleText2.docx": "https://documentserver/SampleText2.docx"
   },
   "end": true
}
{
    "async": false,
    "url": "https://example.com/url-to-example-script.docbuilder"
}

Where the example.com is the name of the server where document storage service are installed. See the How it works section to find out more on Document Server service client-server interactions.

Response example
{
   "key": "af86C7e71Ca8",
   "urls": {
      "SampleText.docx": "https://documentserver/SampleText.docx",
      "SampleText2.docx": "https://documentserver/SampleText2.docx"
   },
   "end": true
}
{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3luYyI6dHJ1ZSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1zY3JpcHQuZG9jYnVpbGRlciJ9.dzoTbRzSMa95Fpg34CjnF3ZUPdGA2CnBedFL_qOOxAs"
}
Example of the response when an error occurred
{
    "error": -8
}
Possible error codes and their description
Error code Description
-1 Unknown error.
-2 Generation timeout error.
-3 Document generation error.
-4 Error while downloading the document file to be generated.
-6 Error while accessing the document generation result database.
-8 Invalid token.