Qodex.ai

Athento API Reference

Number of APIs: 25

Athento offers a powerful and easy-to-use REST API. Athento's API allows you to create, manage and control your digital content on the platform. This is a collection that includes requests to all endpoints in Athento's API.

If you are new to Athento, please have a look at our course Getting Started with Athento.

If you want to learn to integrate more visually, we recommend you to have a look at our course Integrating my App with Athento.

What's in the collection?

The endpoints are organized according to the operation to perform:

  • Creating documents

  • Updating documents

  • Searching documents

  • Retrieving and Downloading documents

  • Deleting documents

Authorization

You can use Basic Auth or bearer token to access to authenticate. In this sample collection, we will use BasicAuth.

We recommend using SSL always.

How to try these web services

If you are a current customer, you can use your own details to try the web services in this collection.

If you are not, you can create a trial account here.

  1. Creating documents - Create new document with content POST https://{{host}}/athento/site/automation/Athento.DocumentCreate/

  2. Creating documents - Attach Content POST https://{{host}}/athento/site/automation/Blob.Attach/

  3. Updating documents - Update document POST https://{{host}}/athento/site/automation/Athento.DocumentUpdate/

  4. Searching documents - Search document by form POST https://{{host}}/athento/site/automation/Athento.DocumentResultSet/

  5. Searching documents - Search document by hash POST http://{{host}}/athento/site/automation/Athento.DocumentResultSet/

  6. Retrieving and Downloading documents - Download document GET https://{{host}}/athento/api/v1/id/a7e7c74c-ca91-41d0-9f47-c4960ed99b13/@blob/file:content?inline=true&url_link=true

  7. Retrieving and Downloading documents - Retrieve document metadata GET https://{{host}}/athento/api/v1/id/a7e7c74c-ca91-41d0-9f47-c4960ed99b13/retrieve

  8. Retrieving and Downloading documents - Public download or preview GET https://{{host}}/file/public/76ae6d45-8615-4fe2-92fc-8d2c580e5f59?mode=preview

  9. Retrieving and Downloading documents - Fetch document POST https://{{host}}/athento/site/automation/Document.Fetch/

  10. Deleting documents - Delete document POST https://{{host}}/athento/site/automation/Athento.DocumentDelete/