--- title: AX Semantics slug: import-test-pdf/ax-semantics createdAt: 2025-10-23T07:50:10.405Z --- The AX Semantics modules allow you to monitor, create, update, send, retrieve, list, and delete the documents from your AX Semantics account. ## Getting Started with AX Semantics Prerequisites - An AX Semantics account - create an account at [en.ax-semantics.com/](https://en.ax-semantics.com/). :::hint{type="success"} ### Note The module dialog fields that are displayed in **bold** (in the , **not** in this documentation article) are mandatory! ::: ## Connecting AX Semantics to To connect your AX Semantics account to you need to obtain the Refresh Token from your AX Semantics account and insert it in the *Create a connection* dialog in the module. 1. Log in to your AX Semantics account. 2. Click *API Access*. ![61f26690685d2.png](../image/uuid-12dd1aad-5839-f707-8660-4d37c4a188de.png) 3. Copy the Refresh Token to your clipboard. ![61f2669199428.png](../image/uuid-9c04251f-bc55-c7fe-1861-86f6e095d21c.png) 4. Log in to your account, add a module from the AX Semantics app into an scenario. 5. Click *Add* next to the *Connection* field. ![61f2669307202.gif](../image/uuid-c69435e4-562b-8433-2d40-27968c26ccba.gif) 6. In the *Connection name* field, enter a name for the connection. 7. In the *Refresh Token* field, enter the token details copied in step 3 and click *Continue*. The connection has been established. ## Triggers ### [Watch Generated Content](#watch-generated-content-2431741_body) Triggers when new content is generated. | **Webhook Name** | Enter a name for the webhook. | | ---------------- | ------------------------------------------------------------------------------------------------------------ | | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | See the [Setting Up AX Semantics Webhooks ](ax-semantics.html#setting-up-ax-semantics-webhooks-2431741)to add webhooks in your AX Semantics account. ## Actions ### [Add a Document](#add-a-document-2431741_body) Uploads your data. | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Collection ID** | Select or map the Collection ID of the document. | | **Document Data** | Enter (map) the document data in the JSON format to publish the content in your collection. You can provide either a name and/or UID parameters that help to find your document easily. | ### [Update a Document](#update-a-document-2431741_body) Updates an existing document. | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Collection ID** | Select or map the collection ID of the document which you want to update. | | **Document ID** | Select or map the Document ID whose details you want to update. | | **Document Data** | Enter (map) the document data in the JSON format to publish the content in your collection. You can provide either a name and/or UID parameters that help to find your document easily. | ### [Get Details of a Document](#get-details-of-a-document-2431741_body) Shows details of a document. | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | | ----------------- | ------------------------------------------------------------------------------------------------------------ | | **Collection ID** | Select or map the Collection ID whose document details you want to retrieve. | | **Document ID** | Select or map the Document ID whose details you want to retrieve. | ### [Delete a Document](#delete-a-document-2431741_body) Deletes a document. | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | | ----------------- | ------------------------------------------------------------------------------------------------------------ | | **Collection ID** | Select or map the Collection ID whose document you want to delete. | | **Document ID** | Select or map the Document ID you want to delete. | ### [Make an API Call](#make-an-api-call-2431741_body) Performs an arbitrary authorized API call. | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **URL** | Enter a path relative to `https://api.ax-semantics.com` For example: `/v3/documents/`
For the list of available endpoints, refer to the [AX Semantics API Documentation](https://developers.ax-semantics.com/). | | **Method** | Select the HTTP method you want to use:
**GET**
to retrieve information for an entry.
**POST**
to create a new entry.
**PUT**
to update/replace an existing entry.
**PATCH**
to make a partial entry update.
**DELETE**
to delete an entry. | | **Headers** | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. | | **Query String** | Enter the request query string. | | **Body** | Enter the body content for your API call. | ### [Example of Use - List Collections](#example-of-use---list-collections-2431741_body) The following API call returns all the collections from your AX Semantics account: **URL**: `/v3/collections/` **Method**: `GET` ![61f266959faa1.png](../image/uuid-72f96119-2e68-8dea-7fbe-ce9a493f0689.png) Matches of the search can be found in the module's **Output** under *Bundle* > *Body > results.* In our example, 104 collections were returned: ![61f26696e2fc2.png](../image/uuid-6915a0e9-ca28-93a1-bc61-edceb70146a1.png) ## Searches ### [Search Documents](#search-documents-2431741_body) Search documents by given criteria. | **Connection** | [Establish a connection to your AX Semantics account](ax-semantics.html#connecting-ax-semantics-to-2431741). | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Collection ID** | Select or map the Collection ID whose documents you want to search. | | **Processing State** | Select or map the document processing status:
- *Generated*
- *Requested*
- *Delivered*
- *None* | | **Ordering** | Select or map the order to arrange the documents:
- *Newest changes first*
- *Oldest changes first* | | **Modified Before** | Enter (map) the date to search the documents that were modified on or before the specified date. See [the list of supported date and time formats](../mapping/date-examples.html). | | **Modified Since** | Enter (map) the date to search the documents that were modified on or after the specified date. See [the list of supported date and time formats](../mapping/date-examples.html). | | **Limit** | Set the maximum number of results should return during one execution cycle. | ### [Setting Up AX Semantics Webhooks](#setting-up-ax-semantics-webhooks-2431741_body) 1. Open the *Watch Generated Content* module, enter a name for the webhook, click *Save*, and copy the URL address to your clipboard. Click *OK* and save the trigger. ![61f2669820854.gif](../image/uuid-74752b4f-3f63-f38b-3fe4-45faf1b1af9a.gif) 2. Log in to your AX Semantics account. 3. Click the Project in which you want to add the webhook. ![61f2669acc99e.png](../image/uuid-5500316c-f02c-03db-0619-6f621fd0cd20.png) 4. Click the Settings button. ![61f2669be5cc0.png](../image/uuid-b6874cdd-8401-2fcf-e4ee-9ef6e89a7730.png) 5. Click *Instant Generation Endpoints*. ![61f2669d22059.png](../image/uuid-dd5e9cc4-fb0c-4970-4819-a92cff5b24c9.png) 6. Click *Create a New Instant Generation Endpoint* and enter the URL address copied in step 1. ![61f2669e619c6.png](../image/uuid-a52a998e-137c-b99c-4d5b-02ef38dd64e8.png)