Camunda Orchestration Cluster API

Name: Orchestration Cluster API
Brand: Orchestration Cluster API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsProject Managementbearer, basic151 EndpointsREST

For Agents

Install Jentic One Beta

Connect the Orchestration Cluster API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Orchestration Cluster API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcamunda.com%2Fcamunda" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcamunda.com%2Fcamunda" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Orchestration Cluster API.

Deploy BPMN process and DMN decision definitions to a Camunda 8 cluster via /resources

Start, search, cancel, and modify process instances via /process-instances and /process-instances/search

Claim, assign, and complete user tasks via the /user-tasks resource

GET STARTED

Start building with Orchestration Cluster API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Orchestration Cluster API for, with concrete tasks.

★ Process Orchestration for AI Agent Workflows

Engineering teams encoding multi-step agent workflows in BPMN can use the Orchestration Cluster API to deploy the diagram, start instances when a user request arrives, and complete user tasks as steps finish. The /process-instances and /user-tasks resources expose the lifecycle controls needed to embed Camunda as the durable state machine behind an agent.

POST /process-instances to start a 'customer-onboarding' process with the new customer's email as a variable, then POST to /user-tasks/{userTaskKey}/completion when each manual step is finished.

Incident Monitoring and Recovery

Operations teams monitoring long-running business processes need to spot stuck instances and recover them without manual database edits. The /incidents resource lists open incidents, /incidents/{incidentKey}/resolution clears them once root cause is fixed, and /process-instances/search filters by state to surface processes blocked by incidents.

GET /incidents/search filtered by errorType, resolve each by calling /incidents/{incidentKey}/resolution, and report the count of incidents cleared.

Message Correlation for Event-Driven Processes

Event-driven Camunda processes wait at message catch events until a correlated message arrives. The /messages publication endpoint lets external services push correlation messages by name and key, advancing waiting instances without polling.

POST /messages with name='payment-received' and correlationKey=order-id to advance the matching process instance past its message catch event.

AI Agent Process Workflows via Jentic

Through Jentic, an agent searches for 'start a process instance', loads the input schema for /process-instances, and executes the call without managing bearer or basic credentials. Jentic's vault holds the cluster credential and injects it at execution time, keeping cluster access tightly scoped.

Use the Jentic SDK to search 'start a process instance', load the /process-instances operation schema, and execute it with the BPMN process ID and a variable map.

Key Endpoints

151 endpoints — jentic publishes the only available openapi specification for orchestration cluster api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/process-instances

Start a new process instance

POST

/process-instances/search

Search for process instances

POST

/user-tasks/search

Search user tasks across the cluster

POST

/messages/publication

Publish a message for correlation

POST

/incidents/search

Search incidents in the cluster

POST

/resources/deployment

Deploy BPMN and DMN resources

POST

/jobs/activation

Activate jobs for an external task worker

POST

/process-instances

Start a new process instance

POST

/process-instances/search

Search for process instances

POST

/user-tasks/search

Search user tasks across the cluster

POST

/messages/publication

Publish a message for correlation

POST

/incidents/search

Search incidents in the cluster

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Orchestration Cluster API by hand means resolving your cluster's schema, host, and port template, choosing between Bearer JWT and Basic auth, and finding the right runtime routes across 151 operations. Through Jentic you install once, import the Camunda Orchestration Cluster API from the API Directory, store the credential once, and your agent calls it.

Permission scoping

This API takes process, task, and message inputs in the request body rather than as a resource in the URL path, so limit the agent to the operations it needs, such as searching process instances and user tasks. You choose the operations it may call, so state-changing ones like creating process instances or activating jobs are not included unless you add them.

Credential isolation

Your Camunda cluster credential, whether a Basic password or a Bearer JWT, is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'start a process instance' or 'search for open user tasks', and Jentic returns the matching Camunda operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Orchestration Cluster API through Jentic.

Why is there no official OpenAPI spec for Orchestration Cluster API?

Camunda does not publish a single consolidated OpenAPI specification for the v2 Orchestration Cluster REST API. Jentic generates and maintains this spec so that AI agents and developers can call Camunda 8 via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Orchestration Cluster API use?

It supports HTTP Basic auth and HTTP Bearer auth with a JWT. Self-managed clusters typically use Basic; Camunda 8 SaaS uses a JWT obtained from its OAuth provider. Through Jentic, the credential is held in your Jentic One instance and injected into the Authorization header at execution time so it never enters the agent's prompt context.

Can I start a process instance through Jentic?

Yes. Search 'start a process instance' through the Jentic SDK. Jentic returns POST /process-instances with its input schema. Provide the BPMN processDefinitionKey or processDefinitionId and a variable map to begin execution.

How do I complete a user task assigned to a human?

Call the user-task completion endpoint under /user-tasks/{userTaskKey} with the variables to be set on completion. Use /user-tasks/search first to find the task by assignee, candidate group, or process instance key.

What is the base URL of the API?

The base URL is configurable via server variables: {schema}://{host}:{port}/v2, defaulting to http://localhost:8080/v2 for self-managed clusters. Camunda 8 SaaS replaces these with the cluster-specific gateway URL provided in the Console.

Can the API publish messages to running process instances?

Yes. POST to the /messages publication endpoint with a message name and correlation key. Camunda routes the message to any waiting message catch events in process instances whose correlation key matches.

Can I limit what my agent is allowed to do with the Orchestration Cluster API?

Yes. Because you self-host Jentic One, your own rules decide which of the 151 Orchestration Cluster operations the agent may call, so you can grant it read-only actions like searching process instances, user tasks, or incidents while excluding everything else. State-changing operations such as starting a process instance, completing a user task, publishing a message, or activating jobs are only available if you explicitly add them. The cluster credential, whether a Basic password or a Bearer JWT, is stored by your Jentic One instance and injected at execution time, so it never reaches the agent's prompt or logs.

Camunda Orchestration Cluster API

Connect the Orchestration Cluster API to your agent

Capabilities

Start building with Orchestration Cluster API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs