API Reference: Processes

These endpoints work against your own workspace — start a free trial to create one and make your first API call.

List processes

Endpoint: GET /v1/tenant/{tenantId}/processes

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
limit	integer	query	No	Maximum number of items to return
offset	integer	query	No	Number of items to skip

Response (200):

List of processes

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

Errors:

• 401 Missing, invalid, disabled or expired API key

Create a process (with an empty model)

Endpoint: POST /v1/tenant/{tenantId}/processes

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid

Request Body:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}

Field	Type	Required	Description
displayName	string	Yes	Process name shown in the process tree Max length: 128
treeParentId	string	No	Parent folder id (null = top level) Format: uuid
treeNodeType	Process | TreeGroup	No	Process or TreeGroup (folder) Allowed values: Process, TreeGroup Default: Process

Response (201):

Created process

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
treeParentId	string	Yes	Format: uuid
treeNodeType	Process | TreeGroup	Yes	Allowed values: Process, TreeGroup Default: Process
displayName	string	Yes	Default: New Process Max length: 128
createdAt	string	Yes	Format: date-time
updatedAt	string	Yes	Format: date-time
designerModelId	string	Yes	Format: uuid

Errors:

• 401 Missing, invalid, disabled or expired API key
• 500 Unexpected server error: the request can be retried safely

Get a process

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Response (200):

Process

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
treeParentId	string	Yes	Format: uuid
treeNodeType	Process | TreeGroup	Yes	Allowed values: Process, TreeGroup Default: Process
displayName	string	Yes	Default: New Process Max length: 128
createdAt	string	Yes	Format: date-time
updatedAt	string	Yes	Format: date-time
designerModelId	string	Yes	Format: uuid

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Update a process

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Request Body:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
displayName	string	No	Process name shown in the process tree Max length: 128
treeParentId	string	No	Parent folder id (null = top level) Format: uuid

Response (200):

Updated process

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
treeParentId	string	Yes	Format: uuid
treeNodeType	Process | TreeGroup	Yes	Allowed values: Process, TreeGroup Default: Process
displayName	string	Yes	Default: New Process Max length: 128
createdAt	string	Yes	Format: date-time
updatedAt	string	Yes	Format: date-time
designerModelId	string	Yes	Format: uuid

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found
• 500 Unexpected server error: the request can be retried safely

Soft-delete a process

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Response (200):

Process deleted

{
	"success": true,
	"message": "string"
}

Field	Type	Required	Description
success	boolean	Yes
message	string	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Export the process model as BPMN 2.0 XML

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Response (200):

BPMN XML

{
	"bpmnXml": "string"
}

Field	Type	Required	Description
bpmnXml	string	Yes	BPMN 2.0 XML

Errors:

• 401 Missing, invalid, disabled or expired API key
• 403 API key lacks the required scope or organization access, the tenant is inactive, or the plan blocks the file type
• 404 Resource not found
• 500 Unexpected server error: the request can be retried safely

Import a BPMN 2.0 model for the process (replaces the current model)

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Request Body:

{
	"bpmnXml": "string"
}

Field	Type	Required	Description
bpmnXml	string	Yes	BPMN 2.0 XML

Response (200):

BPMN uploaded

{
	"message": "string"
}

Field	Type	Required	Description
message	string	Yes

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Data mappings connect data tables to processes, allowing you to visualize and analyze your event log data on a process model.

List data mappings for a process

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
limit	integer	query	No	Maximum number of items to return
offset	integer	query	No	Number of items to skip

Response (200):

List of mappings

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Map a datatable to the process (starts processing the event log)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Request Body:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}

Field	Type	Required	Description
dataTableId	string	Yes	Datatable to map to the process Format: uuid
displayName	string	No	Mapping display name Max length: 128
color	object	No	Accent color
showByDefault	boolean	No	Show this mapping by default in the process view Default: true
mappingRole	primary | comparison	No	Role of the mapped data in the model Allowed values: primary, comparison

Response (201):

Mapping created

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
modelId	string	Yes	Format: uuid
dataTableId	string	Yes	Format: uuid
displayName	string	Yes	Max length: 128
color	object	Yes
showByDefault	boolean	Yes	Default: true
mappingRole	primary | comparison	Yes	Allowed values: primary, comparison Default: comparison
sortOrder	integer	Yes	Default: 0 Min: -9007199254740991 Max: 9007199254740991

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 403 API key lacks the required scope or organization access, the tenant is inactive, or the plan blocks the file type
• 404 Resource not found

Update a mapping

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
mappingId	string	path	Yes	Format: uuid

Request Body:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Field	Type	Required	Description
displayName	string	No	Max length: 128
color	object	No
showByDefault	boolean	No
mappingRole	primary | comparison	No	Allowed values: primary, comparison
sortOrder	integer	No	Min: -9007199254740991 Max: 9007199254740991

Response (200):

Updated mapping

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
modelId	string	Yes	Format: uuid
dataTableId	string	Yes	Format: uuid
displayName	string	Yes	Max length: 128
color	object	Yes
showByDefault	boolean	Yes	Default: true
mappingRole	primary | comparison	Yes	Allowed values: primary, comparison Default: comparison
sortOrder	integer	Yes	Default: 0 Min: -9007199254740991 Max: 9007199254740991

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Delete a mapping

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
mappingId	string	path	Yes	Format: uuid

Response (200):

Mapping deleted

{
	"success": true,
	"message": "string"
}

Field	Type	Required	Description
success	boolean	Yes
message	string	Yes

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

These endpoints use AI to automatically generate BPMN process models from natural language descriptions.

Generate a process model from a natural-language prompt (async; poll the status endpoint)

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

Auth: Tenant-scoped API key · write scope · rate limit 2 req/s (burst 4)

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Request Body:

{
	"prompt": "string"
}

Field	Type	Required	Description
prompt	string	Yes

Response (200):

Generation started / result

{
	"message": "string"
}

Field	Type	Required	Description
message	string	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Poll model generation status

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Response (200):

Generation status

{
	"message": "string"
}

Field	Type	Required	Description
message	string	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

The per-case metrics of the process’s latest model: one row per case with the computed sequence and health metrics.

Get per-case metrics of a process (latest model, paged)

Returns one row per case with the computed process metrics (case duration, length, conformance, rework, health score, variant, and more) for the process’s latest model. No row filtering is applied. The result is paged: use limit (default 1000, max 10000) and offset, and keep paging while hasMore is true. While the metrics are still being computed, the response has state preprocessing.

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
limit	integer	query	No	Maximum number of case rows to return (default 1000, max 10000)
offset	integer	query	No	Number of case rows to skip (default 0)

Response (200):

Case metrics

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found
• 503 Data pipeline not ready or an upstream query failed

List process versions

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
limit	integer	query	No	Maximum number of items to return
offset	integer	query	No	Number of items to skip

Response (200):

List of versions

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Create a version snapshot of the process

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/versions

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Request Body:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
displayName	string	No	Version label Default: "" Max length: 128
description	string	No	Optional description of the version
versionType	manual | auto	No	manual = user-created, auto = created by the system Allowed values: manual, auto
restoreFromVersionId	string	No	Version to restore from when creating this snapshot Format: uuid

Response (201):

Version created

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Field	Type	Required	Description
version	object	Yes
restoredFrom	object	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Get a process version

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
versionId	string	path	Yes	Format: uuid

Response (200):

Version

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Field	Type	Required	Description
version	object	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Rename or update a process version

Endpoint: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
versionId	string	path	Yes	Format: uuid

Request Body:

{
	"displayName": "string",
	"description": "string"
}

Field	Type	Required	Description
displayName	string	No	Version label Max length: 128
description	string	No	Optional description of the version

Response (200):

Updated version

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}

Field	Type	Required	Description
version	object	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Delete a process version

Endpoint: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
versionId	string	path	Yes	Format: uuid

Response (200):

Version deleted

{
	"deleted": true
}

Field	Type	Required	Description
deleted	boolean	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Get an artifact

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
artifactId	string	path	Yes	Format: uuid

Response (200):

Artifact

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
displayName	string	Yes	Default: "" Max length: 500
description	string	Yes	Max length: 2000
originalFileName	string	Yes	Default: "" Max length: 500
mimeType	string	Yes	Default: "" Max length: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Yes	Allowed values: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Yes	Allowed values: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Default: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Yes	Allowed values: Uploading, Ready, Failed, Deleted Default: Uploading
hasThumbnail	boolean	Yes	Default: false
sizeBytes	number	Yes	Default: 0
createdAt	string	Yes	Format: date-time
createdBy	string	No	Format: uuid

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Update an artifact’s display name or description

Endpoint: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
artifactId	string	path	Yes	Format: uuid

Request Body:

{
	"displayName": "string",
	"description": "string"
}

Field	Type	Required	Description
displayName	string	No	Artifact name Max length: 500
description	string	No	Optional description of the artifact Max length: 2000

Response (200):

Updated artifact

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Field	Type	Required	Description
id	string	Yes	Format: uuid
displayName	string	Yes	Default: "" Max length: 500
description	string	Yes	Max length: 2000
originalFileName	string	Yes	Default: "" Max length: 500
mimeType	string	Yes	Default: "" Max length: 200
kind	Image | Pdf | Docx | Xlsx | Pptx | Text | Video	Yes	Allowed values: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType	modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage	Yes	Allowed values: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage Default: modelIcon
uploadState	Uploading | Ready | Failed | Deleted	Yes	Allowed values: Uploading, Ready, Failed, Deleted Default: Uploading
hasThumbnail	boolean	Yes	Default: false
sizeBytes	number	Yes	Default: 0
createdAt	string	Yes	Format: date-time
createdBy	string	No	Format: uuid

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Delete an artifact

Endpoint: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
artifactId	string	path	Yes	Format: uuid

Response (200):

Artifact deleted

{
	"deleted": true
}

Field	Type	Required	Description
deleted	boolean	Yes

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Redirect to a presigned URL to download the artifact

Endpoint: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
artifactId	string	path	Yes	Format: uuid

Errors:

• 302 Redirect to presigned download URL
• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

List artifacts attached to a process

Endpoint: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

Auth: Tenant-scoped API key · read scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid
limit	integer	query	No	Maximum number of items to return
offset	integer	query	No	Number of items to skip

Response (200):

List of process artifacts

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

Errors:

• 401 Missing, invalid, disabled or expired API key
• 404 Resource not found

Get a presigned S3 upload URL for a new process artifact

Endpoint: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

Auth: Tenant-scoped API key · write scope

Parameters:

Name	Type	Location	Required	Description
tenantId	string	path	Yes	Format: uuid
processId	string	path	Yes	Format: uuid

Request Body:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}

Field	Type	Required	Description
fileName	string	Yes
mimeType	string	Yes
sizeBytes	number	Yes
artifactType	modelIcon | processArtifact | doc | levelFrontPageImage	No	Allowed values: modelIcon, processArtifact, doc, levelFrontPageImage Default: processArtifact

Response (200):

Presigned upload URL

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}

Field	Type	Required	Description
artifactId	string	Yes	Format: uuid
originalUrl	string	Yes
thumbnailUrl	string	Yes

Errors:

• 400 Bad request: e.g. an invalid filter expression, a process without a model, an unsupported upload type or a missing required field
• 401 Missing, invalid, disabled or expired API key
• 403 API key lacks the required scope or organization access, the tenant is inactive, or the plan blocks the file type
• 404 Resource not found
• 409 The request conflicts with the current state (e.g. a seat gate or a reused id)