AI

AX Semantics

11min

With the AX Semantics app in , you can manage the documents in your AX Semantics account.

Requirements

To use the AX Semantics app in , you must have an AX Semantics account.

Connect AX Semantics and 

To get started, you must first create a connection between AX Semantics and , allowing the two services to communicate.

To create the connection, you need to:

Obtain your Refresh Token in AX Semantics

Before you create the connection in , you should first obtain a Refresh token in your AX Semantics account.

To obtain the Refresh token:

1

Log in to your AX Semantics account.

2

Click API Access.

3

Copy the Refresh Token value and store it in a safe place.

You'll use this value in the Refresh Token connection field in .

Create the connection in 

Once you have your AX Semantics Refresh Token, you're ready to create the connection in .

To create the connection:

1

Log in to your account, add an AX Semantics module to your , and click Create a connection.

2

Optional: In the ​​Connection name​​ field, enter a name for the connection.

3

In the ​​Refresh Token field, enter the Refresh Token you copied from your AX Semantics account.

4

Click Save.

5

If prompted, authenticate your account and confirm access.

You've successfully created the connection and can now use the AX Semantics app in your . If you want to make changes to your connection in the future, follow the steps here.

Set up an AX Semantics webhook

The AX Semantics app has instant modules—webhooks that watch for certain changes in AX Semantics and immediately start your when those changes happen. To use these modules, you must set up the webhook in your AX Semantics account.

To set up the webhook:

1

Add an AX Semantics instant​ module to your and click Create a webhook​​.

2

Optional: Enter a name for the webhook in the ​Webhook name​​ field.

3

Click ​Save​ > ​Copy address to clipboard​​. You'll paste this address in your {app name} account.

4

Log in to your AX Semantics account.

5

Click the Project in which you want to add the webhook.

6

Click the Settings button.

7

Click Instant Generation Endpoints.

8

Click Create a New Instant Generation Endpoint and enter the URL address copied in step 3.

Your webhook is now set up. When the selected change occurs in AX Semantics, will immediately be notified and start your .

Triggers

Triggers when new content is generated.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your AX Semantics account.

Actions

Uploads your data.

Connection

Establish a connection to your AX Semantics account.

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.

Updates an existing document.

Connection

Establish a connection to your AX Semantics account.

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.

Shows details of a document.

Connection

Establish a connection to your AX Semantics account.

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.



Deletes a document.

Connection

Establish a connection to your AX Semantics account.

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.

Performs an arbitrary authorized API call.

Connection

Establish a connection to your AX Semantics account.

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.

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.



The following API call returns all the collections from your AX Semantics account:

URL:

/v3/collections/

Method:

GET



Document image


Searches

Search documents by given criteria.

Connection

Establish a connection to your AX Semantics account.

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.

Modified Since

Enter (map) the date to search the documents that were modified on or after the specified date.

Limit

Set the maximum number of results should return during one execution cycle.





Updated 10 Mar 2025
PREVIOUS
ArtiBot.ai
NEXT
AX Semantics modules
Docs powered by Archbee