> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/documentation/documentation-en/wprowadzenie/architektura-platformy/eximee-api.md).

# Eximee API

**Eximee API** is the unified integration layer of the Eximee platform, which is divided into:

1. **EximeeBPMS API** – handling of processes, tasks, and history in the BPMN 2.0 model.
2. **Eximee API** – access to case statuses, document generator, data model, configuration, and event notifications.

## EximeeBPMS API

### Role and architecture

Interface for launching and supervising process instances, managing user and automated tasks, event communication, and reviewing case history. Designed to work with EximeeBPMS and other engines implementing BPMN 2.0.

### Functional scope

* **Process instances**\
  • start a process instance (with separation of business and process data),\
  • retrieve instance details (including process and business variables).
* **Process variables**\
  • change the value of a process variable.
* **User Tasks**\
  • retrieve process and business data,\
  • change state,\
  • approve and pass variables,\
  • manage the assigned user.
* **Automated tasks (Service Tasks)**\
  • asynchronous handling of service tasks.
* **Event communication**\
  • sending a message to a process.
* **Incidents**\
  • retrieve incident information,\
  • retry the task on which the incident occurred.
* **Lists and history**\
  • task list, process list, case history.

### Integrations

* **Eximee Forms** – forms as the interface for user tasks.
* **Eximee Case Management** – presentation of task/case lists and history.
* **Eximee Data Model Runtime** – read/write business data during the process.
* **Eximee Dashboard** – UI layer for operational users.

### Security and compliance

* OAuth 2.0 / OIDC (JWT), domain roles, operation auditing.
* TLS 1.2+; rate limiting and the principle of least privilege.

### Example scenarios

* Start a process from CRM and track the instance status.
* Approve a user task with variable transfer.
* Retry a service task incident.

## Eximee API

### Role and architecture

General platform interfaces not directly related to process execution: case status, document generator, data model, configuration, and event notifications.

### Functional scope (methods from the document only)

* **Case status**\
  • create status,\
  • update status,\
  • retrieve status.
* **Document generator**\
  • request document generation based on the provided data (with an option to use the data model).
* **Application data model**\
  • access to **the structure** of the model,\
  • access to **data** (read).
* **Application configuration**\
  • **read-only** access to configuration.
* **Event notifications from external domains**\
  • notify the platform about events in external domains handling processes.

### Integrations

* **Eximee Document Generator** – execution of document generation requests.
* **Eximee Model Runtime** – exposing application structure/data.
* **Eximee Configuration Server** – read-only configuration.
* **External systems** – reporting domain events.

### Security and compliance

* OAuth 2.0 / OIDC (JWT), domain roles, access auditing.
* TLS 1.2+; rate limiting; API versioning (e.g. `/v1/...`).

### Example scenarios​

* CRM reads the structure and data from the model as well as the current case status.
* The scoring system reports an event that triggers further steps on the Eximee side.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.eximee.com/documentation/documentation-en/wprowadzenie/architektura-platformy/eximee-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.