--- title: "DocuWare Aura API and AI agent integration" slug: "docuware-aura-api-and-ai-agent-integration" updated: 2026-10-14T11:56:49Z published: 2026-10-14T11:56:49Z canonical: "knowledgecenter.docuware.com/docuware-aura-api-and-ai-agent-integration" --- > ## Documentation Index > Fetch the complete documentation index at: https://knowledgecenter.docuware.com/llms.txt > Use this file to discover all available pages before exploring further. # DocuWare Aura API and AI agent integration [DocuWare Aura](/help/docs/docuware-aura-configuration) can also be used outside the DocuWare Cloud user interface. The Aura API lets applications send questions to DocuWare Aura and use the answers and source documents in their own applications, portals, automation processes and AI assistants. There are three main ways to use the API. - You can let DocuWare Aura answer the question. - Or you can use Aura only to retrieve the relevant documents and let another application or AI agent do the reasoning. This second option is useful when DocuWare is one of several systems that an external agent needs to work with. - Or you can use the general-purpose LLM API for language tasks that do not involve DocuWare documents at all, such as summarizing or translating a text your application provides. You use the Aura API through your organization's DocuWare Cloud URL. API requests are organization-specific and require the organization's UUID (org_id). All endpoints use a JWT bearer token for authentication. The token is issued by the DocuWare Identity Service (IDS); the Aura API validates the token but does not issue it. The full API definition is available in your DocuWare Cloud. Replace “YourCloudDomain” with your actual Cloud Domain: ```xml https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ ``` ## What you can do with the Aura API The API is useful whenever an application needs DocuWare documents as part of another user experience or business process. Typical examples are: - Add document questions to an ERP, CRM, procurement portal, or other business application. - Answer questions from contracts, agreements, or other documents without sending the user to the DocuWare interface. - Give an external agent access to governed DocuWare document knowledge while the agent combines it with information from other systems . - Use DocuWare as one source of knowledge together with systems such as SharePoint, CRM, ERP or service platforms. DocuWare remains the document repository. The API provides the intelligence layer that an external application can use without requiring the documents to be copied into another system. Document access continues to follow the permissions of the authenticated context. ## Choosing the right API The most important decision is whether you want DocuWare Aura to generate the answer or only retrieve the relevant documents. #### Aura query API Use this when you want DocuWare Aura to understand the question, find the relevant documents and generate the answer. The response also contains the source documents used for the answer. #### Retrieval API Use this when another application or AI model should perform the final reasoning. The Retrieval API finds relevant, authorized documents and returns the sources. #### General-purpose LLM API Use this when your application needs language processing without DocuWare documents, such as generating text, summarizing, translating, rewriting, classifying, improving a text, or turning text into a structured form. The request contains only the text your application sends. DocuWare documents and document retrieval are not involved, and the answer is not based on them. ## Connecting to the API The complete API documentation, including exact endpoints, parameters, schemas, request examples and code snippets, is available directly in the Swagger documentation of your DocuWare Cloud: ```xml https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ ``` ### Main API Endpoints **Ask Aura a question** Use this endpoint for conversational queries. You can optionally specify file cabinets or documents and continue conversations using a session_id. ```json POST /api/v3/{org_id}/query ``` **Single query without conversation** **history** Returns an answer to the current question without using a session. ```json POST /api/v2/{org_id}/single-query ``` **Streaming responses** Streams the answer using Server-Sent Events (SSE), which is useful for chat interfaces. ```json POST /api/v3/{org_id}/query/stream ``` **Document retrieval only** Retrieves relevant DocuWare documents without generating a fulltext answer. ```json POST /api/v2/{org_id}/retrieval-query ``` For the exact request bodies, available parameters, response formats, and ready-to-use code snippets, refer directly to the Swagger documentation in your DocuWare Cloud. **General-purpose language processing** Sends text and a task to the language model, without document retrieval. ```json POST /api/v1/{org_id}/inference ``` Requests to the LLM API consume Aura credits like the other endpoints. The consumption overview of the [Aura configuration](/help/docs/docuware-aura-configuration) lists them under LLM API. ### Other API endpoints The Aura API contains additional endpoints for configuration, document-processing status, conversations, feedback, and related operations. For example, conversation endpoints can list a user's saved conversations, retrieve a conversation with its full message history, rename or pin a conversation and delete a conversation. These endpoints are useful when building a full custom chat experience, but most integrations only need the query or retrieval endpoints described above. The complete endpoint list, request schemas, response schemas, and examples are available in the Swagger documentation. ## Connecting an AI Agent to DocuWare You can use DocuWare as a tool for your external AI agent. The agent can search DocuWare documents and use the results together with information from other systems, such as an ERP or CRM. ### How to get started 1. Open the **Swagger documentation** in your DocuWare Cloud: ```xml https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ ``` 2. Give your agent the API definition If your Agent or AI platform supports OpenAPI/Swagger import, you can provide the Swagger specification directly. The platform can then create the available API tools from it. 3. Configure authentication The agent needs a valid DocuWare JWT to call the API. 4. Choose the API you need - **Query API**: ask Aura questions about documents. - **Retrieval API**: retrieve relevant documents for your own AI model or agent. 5. Let the agent use DocuWare when needed. For example, the agent can get invoice data from an ERP, search the related contract in DocuWare, and then compare both before giving an answer The Swagger documentation contains the exact endpoints, parameters, request/response schemas, and code snippets needed to build the integration. In short: If your agent platform supports OpenAPI, provide it with the DocuWare Swagger/OpenAPI definition, configure the JWT authentication and expose the required DocuWare endpoints as tools. ## Supported versions: DocuWare Cloud