Architectural Overview

Content automation through connecting your systems:

  • your system uploads the data into our REST API, everytime you need a text or the data changes
  • the AX NLG Cloud generates a text from that data and your pre-configured instructions: every data object will be converted to one text.
  • You pull the the generated text from the API or we sent it back automatically to you via webhook push

Upload Data into API

Only 1 request is needed to get data into the NLG Cloud:

  • $data is the data of your object, as json (the keys uid and name are recommended to find your data later on in the interface)
  • The id of the collection (here: "1") is the collection that you created in the interface
  • your API token
$ curl --request POST \
  --url 'https://api.ax-semantics.com/v2/collections/11/document/' \
  --header 'Authorization: JWT 7de3ab043d74ca79dec5b6d7c405' \
  --header 'Content-Type: application/json' \
  --data '{"uid": 222333,"name":"demo","capacity":{"unit":"F","value":4"}}'

Pull Text Back

This will get you a list of all things in a collection, including the text 

$ curl --request GET \
  --url https://api.ax-semantics.com/v2/documents/?collection=11&processing_state=generated' \
  --header 'Authorization: JWT 7de3ab043d74ca79dec5b6d7c405'

This will give you the text as markdown, HTML and with axite tracking code.

{ "id": 456,
  "collection": 11,
  "state": "Success",
  "generated_text_in_html": "<h1>Überschrift</h1>\n<p>Absatz</p>",
  "generated_text": "# Überschrift\nAbsatz",
  "...": "..." }

This is everything that needs to be done.

If you have configured a target url as a webhook, we will do the text delivery automatically.

Further information on API:

Did this answer your question?