Auralis Public API documentation (1.0.24)

This endpoint initiates an Core chat session within the AE system. The chat is configured based on the provided parameters and request body. The client can specify a preferred language for the session, though it's optional. The response will contain the chat's outcome or any relevant error information if the request fails.

This endpoint initiates an Core chat session utilizing Azure's services within the AE system. The chat interaction is configured based on the data provided in the request body. The response will provide details of the chat session or error information if the request fails.

This endpoint creates a new support ticket on Zendesk within the AE system. The request body must include the necessary details for the ticket, such as the issue description and relevant user information. Upon successful creation, the response will include the ticket ID and its status on Zendesk. If the request is invalid or fails, appropriate error responses will be returned.

This endpoint initiates an agent handoff session within Zendesk via the AE system. It allows for the seamless transition of a conversation from an automated system to a human agent. The request body must include the details required to create a support ticket, which will be used to inform the agent about the ongoing issue. A successful response will contain details about the handoff session, ensuring that the human agent has the context needed to continue the interaction. If the request fails, appropriate error information will be returned.

This endpoint allows users to send a message directly to a human agent within the Auralis Core Chat Flow system. The message content and any related metadata must be provided in the request body. Upon successful processing, the response will include details of the sent message, confirming its delivery to the agent. If the request is malformed or contains invalid data, the appropriate error information will be returned.

This endpoint is designed to receive and process webhook notifications from Zendesk. The request body should contain the payload sent by Zendesk, which may include information about ticket updates, user activities, or other events. The server will handle these notifications to integrate Zendesk updates into the Auralis Core Chat Flow system. The response will confirm receipt of the webhook notification or indicate any issues with processing the request.

This endpoint indexes articles from Zendesk by processing the article data provided in the request. The request body should include details about the Zendesk articles to be indexed, such as article IDs or other identifying information. The system will fetch and index the content of these articles to make them searchable. The response will confirm the successful indexing of the articles or provide error details if the request fails.

This endpoint creates a new vector store entry in the vector database. The request body should include the necessary data to define the new vector store, such as the vectors and metadata. The response will contain information about the newly created vector store entry, including any relevant identifiers and status details.

This endpoint updates an existing vector store entry in the vector database. The request body should contain the updated vector data and any other necessary information. The response will provide information about the updated vector store, including confirmation of the changes made.

This endpoint deletes a specific vector store entry from the vector database. The request body should include details required for identifying and removing the vector store entry. Optionally, a widget_id can be provided to specify the associated widget. The response will confirm the deletion of the vector store entry or provide error information if the request fails.

This endpoint indexes web pages by processing the URLs and their content provided in the request. The request body should include details such as the URLs to be indexed and any associated metadata. The system will fetch the content from these URLs, analyze it, and store it in the index for further search and retrieval operations. The response will confirm the successful indexing of the specified websites or indicate any issues encountered during the process.

This endpoint indexes custom data for search and analysis. The request body should include data in a format suitable for indexing, allowing for flexibility in the structure of the input. The system will process this data, analyze its content, and integrate it into the index. The response will provide confirmation of successful indexing or details of any errors encountered during the process.

This endpoint synchronizes and indexes website data for analysis. The request body should include details required to fetch and index the website content. The system will process this data and integrate it into the index, providing a confirmation of successful synchronization or details of any errors encountered.