API Overview

This API reference is synchronized with the backend OpenAPI contract exposed at /v3/api-docs. The same contract powers Swagger UI at /swagger-ui.html.

Base URL

Local development:

http://localhost:8080

Customer environments should replace this with the HTTPS API origin for that deployment.

Authentication

Product endpoints accept a human bearer token or a scoped API client credential where supported. See API Clients API for integration credentials. Sign in with POST /auth/login and send the returned token as:

Authorization: Bearer <token>

OIDC-enabled environments can inspect the active sign-in provider with GET /auth/config.

Interactive API tools

Resource	URL
Swagger UI	/swagger-ui.html
OpenAPI JSON	/v3/api-docs
Static OpenAPI copy in this docs site	Download JSON

API groups

Group	Operations	Page
API Clients	8	API Clients API
SLA	1	SLA API
Authentication	4	Authentication API
Agent Processes	5	Agent Processes API
Processes	16	Processes API
Tasks	11	Tasks API
Forms	5	Forms API
Documents	6	Documents API
Code Tasks	4	Code Tasks API
Incidents	9	Incidents API
Admin Security	11	Admin Security API
Admin Maintenance	7	Admin Maintenance API
Workspace Secrets	11	Workspace Secrets API

Endpoint index

Method	Path	Operation	Request DTO	Response DTO	Group
GET	/admin/api-clients	listApiClients	-	PageApiClientResponse	API Clients API
POST	/admin/api-clients	createApiClient	CreateApiClientRequest	ApiClientCredentialResponse	API Clients API
GET	/admin/api-clients/{id}	getApiClient	-	ApiClientResponse	API Clients API
PATCH	/admin/api-clients/{id}	updateApiClient	UpdateApiClientRequest	ApiClientResponse	API Clients API
GET	/admin/api-clients/{id}/audit	auditApiClient	-	PageApiClientAuditResponse	API Clients API
POST	/admin/api-clients/{id}/revoke	revokeApiClient	-	No body	API Clients API
POST	/admin/api-clients/{id}/rotate	rotateApiClient	RotateApiClientRequest	ApiClientCredentialResponse	API Clients API
GET	/admin/api-clients/assignable-scopes	assignableScopes	-	AssignableScopeList	API Clients API
GET	/admin/sla/metrics	getSlaMetrics	-	PageSlaMetricRow	SLA API
GET	/api/users/me	me_1	-	CurrentUserResponse	Authentication API
GET	/auth/config	config	-	AuthProviderConfigResponse	Authentication API
POST	/auth/login	login	LoginRequest	LoginResponse	Authentication API
GET	/auth/me	me	-	CurrentUserResponse	Authentication API
GET	/agent-processes	Get latest agent process definitions	-	AgentProcessDefinition[]	Agent Processes API
POST	/agent-processes	Deploy an agent process definition	JsonNode	AgentProcessDefinition	Agent Processes API
GET	/agent-processes/{key}	Get latest agent process definition by key	-	AgentProcessDefinition	Agent Processes API
GET	/agent-processes/{key}/versions	Get all versions for an agent process key	-	AgentProcessDefinition[]	Agent Processes API
POST	/agent-processes/simulate	simulateAgentProcess	AgentProcessSimulationRequest	AgentProcessSimulationResponse	Agent Processes API
GET	/processes	Get latest process definitions	-	PageProcessDefinition	Processes API
POST	/processes	Deploy a process definition	string	ProcessDefinition	Processes API
POST	/processes/{processId}/start	Start a process instance	JsonNode	object	Processes API
GET	/processes/definitions/{id}	Get process definition by ID	-	ProcessDefinition	Processes API
GET	/processes/instances	Get process instances	-	PageProcessInstance	Processes API
DELETE	/processes/instances/{id}	Delete process instance	-	No body	Processes API
GET	/processes/instances/{id}	Get process instance by ID	-	ProcessInstance	Processes API
GET	/processes/instances/{id}/children	Get child process instances	-	ProcessInstance[]	Processes API
POST	/processes/instances/{id}/move-node	Move process token	MoveNodeRequest	ProcessInstance	Processes API
GET	/processes/instances/{id}/parent	Get parent process instance	-	ProcessInstance	Processes API
POST	/processes/instances/{id}/stop	Stop process instance	-	ProcessInstance	Processes API
GET	/processes/instances/{id}/timeline	Get process instance timeline	-	ProcessInstanceEvent[]	Processes API
GET	/processes/instances/{id}/variables	Get process variables	-	ProcessVariable[]	Processes API
PUT	/processes/instances/{id}/variables	Assign process variables	AssignProcessVariablesRequest	ProcessVariable[]	Processes API
GET	/processes/instances/{parentId}/children/{childId}/mapping	Get call activity mapping	-	CallActivityMappingResponse	Processes API
POST	/processes/messages	Send a message	object	object	Processes API
GET	/tasks	Get all tasks	-	PageTaskResponseDto	Tasks API
GET	/tasks/{id}	Get task by ID	-	TaskResponseDto	Tasks API
PUT	/tasks/{id}/assignee	Reassign a task	object	TaskResponseDto	Tasks API
POST	/tasks/{id}/claim	Claim a task	-	TaskResponseDto	Tasks API
POST	/tasks/{id}/complete	Complete a task	object	string	Tasks API
POST	/tasks/{id}/draft	Save a task draft	object	TaskResponseDto	Tasks API
GET	/tasks/{id}/sla/events	listTaskSlaEvents	-	PageSlaEventDto	Tasks API
POST	/tasks/{id}/unclaim	Unclaim a task	-	TaskResponseDto	Tasks API
GET	/tasks/search	Search tasks	-	PageTaskResponseDto	Tasks API
POST	/tasks/search	Search tasks with structured filters	TaskSearchRequestDto	PageTaskResponseDto	Tasks API
POST	/tasks/sla/summary	summarizeTaskSla	TaskSearchRequestDto	SlaSummary	Tasks API
GET	/forms	Get all form versions	-	Form[]	Forms API
POST	/forms	Deploy a form	DeployFormRequest	Form	Forms API
GET	/forms/{id}	Get form by ID	-	Form	Forms API
GET	/forms/latest	Get latest form version	-	Form	Forms API
GET	/forms/latest-list	Get latest form definitions	-	Form[]	Forms API
GET	/api/documents	List documents	-	DocumentResponseDto[]	Documents API
POST	/api/documents	Upload a document	object	DocumentResponseDto	Documents API
DELETE	/api/documents/{id}	Delete a document	-	No body	Documents API
GET	/api/documents/{id}	Get document metadata	-	DocumentResponseDto	Documents API
GET	/api/documents/{id}/download	Download a document	-	string(binary)	Documents API
GET	/api/documents/{id}/preview	Preview a document inline	-	string(binary)	Documents API
GET	/code-tasks/executions	getExecutions	-	ExecutionAuditPageResponse	Code Tasks API
GET	/code-tasks/jar/{jarId}/classes	getJarClasses	-	JarClassesResponse	Code Tasks API
GET	/code-tasks/jar/{jarId}/classes/{className}/methods	getClassMethods	-	ClassMetadataResponse	Code Tasks API
POST	/code-tasks/upload	uploadJar	object	CodeTaskJarUploadResponse	Code Tasks API
GET	/incidents	List incidents	-	PageIncident	Incidents API
GET	/incidents/{id}	Get incident by ID	-	Incident	Incidents API
POST	/incidents/{id}/acknowledge	Acknowledge incident	IncidentAcknowledgementRequest	Incident	Incidents API
GET	/incidents/{id}/events	Get incident timeline	-	IncidentEvent[]	Incidents API
POST	/incidents/{id}/reopen	Reopen incident	-	Incident	Incidents API
POST	/incidents/{id}/resolve	Resolve incident	IncidentResolutionRequest	Incident	Incidents API
POST	/incidents/{id}/retry	Retry incident	IncidentRetryRequest	Incident	Incidents API
GET	/incidents/process-instances/{processInstanceId}	Get incidents for process instance	-	Incident[]	Incidents API
GET	/incidents/summary	Get incident summary	-	IncidentSummaryResponse	Incidents API
GET	/admin/groups	listGroups	-	GroupResponse[]	Admin Security API
POST	/admin/groups	createGroup	CreateGroupRequest	GroupResponse	Admin Security API
DELETE	/admin/groups/{id}	deleteGroup	-	No body	Admin Security API
PUT	/admin/groups/{id}	updateGroup	UpdateGroupRequest	GroupResponse	Admin Security API
GET	/admin/groups/{id}/users	getGroupUsers	-	UserResponse[]	Admin Security API
PUT	/admin/groups/{id}/users	updateGroupUsers	UpdateGroupUsersRequest	UserResponse[]	Admin Security API
GET	/admin/users	listUsers	-	UserResponse[]	Admin Security API
POST	/admin/users	createUser	CreateUserRequest	UserResponse	Admin Security API
DELETE	/admin/users/{id}	deleteUser	-	No body	Admin Security API
PUT	/admin/users/{id}	updateUser	UpdateUserRequest	UserResponse	Admin Security API
PUT	/admin/users/{id}/password	resetPassword	ResetPasswordRequest	No body	Admin Security API
DELETE	/admin/maintenance/process-definitions/{id}	Delete process definition	-	MaintenanceCleanupSummary	Admin Maintenance API
POST	/admin/maintenance/purge-completed-instances	Purge completed instances	PurgeCompletedInstancesRequest	MaintenanceCleanupSummary	Admin Maintenance API
POST	/admin/maintenance/purge-completed-tasks	Purge completed tasks	PurgeCompletedTasksRequest	MaintenanceCleanupSummary	Admin Maintenance API
GET	/admin/maintenance/retention	Get data retention settings	-	DataRetentionSettingsResponse	Admin Maintenance API
PUT	/admin/maintenance/retention	Update data retention settings	UpdateDataRetentionSettingsRequest	DataRetentionSettingsResponse	Admin Maintenance API
POST	/admin/maintenance/retention/preview	Preview configured retention	-	MaintenanceCleanupSummary	Admin Maintenance API
POST	/admin/maintenance/retention/run	Run configured retention	-	MaintenanceCleanupSummary	Admin Maintenance API
GET	/admin/secrets	listSecrets	-	AICredentialResponseDto[]	Workspace Secrets API
POST	/admin/secrets	createSecret	AICredentialCreateRequestDto	AICredentialResponseDto	Workspace Secrets API
DELETE	/admin/secrets/{id}	deleteSecret	-	No body	Workspace Secrets API
PUT	/admin/secrets/{id}	updateSecret	AICredentialUpdateRequestDto	AICredentialResponseDto	Workspace Secrets API
GET	/ai/credentials	listCredentials	-	AICredentialResponseDto[]	Workspace Secrets API
POST	/ai/credentials	createCredential	AICredentialCreateRequestDto	AICredentialResponseDto	Workspace Secrets API
DELETE	/ai/credentials/{id}	deleteCredential	-	No body	Workspace Secrets API
GET	/ai/credentials/{id}	getCredential	-	AICredentialResponseDto	Workspace Secrets API
GET	/ai/credentials/{id}/valid	isCredentialValid	-	object	Workspace Secrets API
GET	/ai/credentials/available	listAvailableCredentials	-	AICredentialResponseDto[]	Workspace Secrets API
GET	/secrets/available	listAvailableSecrets	-	AICredentialResponseDto[]	Workspace Secrets API