Pre-release

This release is a pre-release and may not be stable for production use.

Neops Workflow Engine Client

Neops workflow engine API documentation

This Python package is automatically generated by the OpenAPI Generator project:

API version: develop
Package version: 0.46.0-beta.4
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import neops_workflow_engine_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import neops_workflow_engine_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import neops_workflow_engine_client
from neops_workflow_engine_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = neops_workflow_engine_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with neops_workflow_engine_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neops_workflow_engine_client.AppApi(api_client)

    try:
        api_response = await api_instance.app_controller_get_hello()
        print("The response of AppApi->app_controller_get_hello:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AppApi->app_controller_get_hello: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AppApi	app_controller_get_hello	GET /
BlackboardApi	blackboard_controller_poll_job	POST /blackboard/job	Poll for available jobs
BlackboardApi	blackboard_controller_push_job_result	POST /blackboard/job/result	Submit job execution result
BlackboardApi	blackboard_controller_show_active_jobs	GET /blackboard/jobs/active	List active jobs
BlackboardApi	blackboard_controller_show_jobs	GET /blackboard/jobs	List jobs with optional status filter
BlackboardApi	find_job_logs	GET /blackboard/jobs/{jobId}/logs	Retrieve a page of the log lines of one job
BlackboardApi	push_job_logs	POST /blackboard/job/logs	Push log lines of a job
BlackboardApi	show_job_result	GET /blackboard/jobs/{jobId}/result	Read what a job returned, whole
BlackboardApi	show_jobs_page	GET /blackboard/jobs/page	List a page of jobs
FunctionBlockApi	function_blocks_controller_find_all	GET /function-blocks/registrations/list	List all registered function blocks
FunctionBlockApi	function_blocks_controller_find_one_fb	GET /function-blocks/{pkg}/{name}/{version}	Get a function block by ID
FunctionBlockApi	function_blocks_controller_find_one_fb_registration	GET /function-blocks/registrations/{pkg}/{name}/{version}	Get a function block registration by ID
FunctionBlockApi	function_blocks_controller_get_workers_for_function_block	GET /function-blocks/{pkg}/{name}/{version}/workers	Get workers for a function block
FunctionBlockApi	function_blocks_controller_register	POST /function-blocks/register	Register a function block
FunctionBlockApi	function_blocks_controller_soft_delete	DELETE /function-blocks/{pkg}/{name}/{version}	Soft-delete a function block by ID
HealthApi	health_controller_healthy	GET /health	Check service health status
HealthApi	health_controller_live	GET /health/live	Check that the process serves HTTP, reading no dependency
LicenseApi	license_controller_get	GET /license	Return active license flavor, limits, live usage, and feature toggles
LogsApi	find_logs	GET /logs	Retrieve a page of log lines across runs
MonitoringApi	get_me	GET /me	Echo the validated claims of the calling principal
SchemaApi	schema_controller_get_schema	GET /schema	Get the RootWorkflow JSON Schema of the workflow engine
VersionApi	version_controller_check_compatibility	POST /version/compatibility	Check version compatibility
VersionApi	version_controller_get_version	GET /version	Get version of the service
WorkersApi	find_worker_logs	GET /workers/{uuid}/logs	Retrieve a page of the log lines of one worker: outside any job, or its job lines by workflow or function block
WorkersApi	list_network_zones	GET /network-zones	List the network zones the engine knows
WorkersApi	push_worker_logs	POST /workers/{uuid}/logs	Push log lines of a worker outside any job
WorkersApi	workers_controller_cleanup	POST /workers/cleanup	Manually trigger cleanup of stale workers (offline > cleanup threshold)
WorkersApi	workers_controller_cleanup_offline	POST /workers/cleanup-offline	Clean up all currently offline workers (immediate)
WorkersApi	workers_controller_find_all	GET /workers	List all registered workers
WorkersApi	workers_controller_find_one	GET /workers/{uuid}	Get a worker by UUID
WorkersApi	workers_controller_find_online	GET /workers/online	List online workers only
WorkersApi	workers_controller_get_function_blocks	GET /workers/{uuid}/function-blocks	Get function blocks for a worker
WorkersApi	workers_controller_get_jobs	GET /workers/{uuid}/jobs	Get jobs for a worker
WorkersApi	workers_controller_ping	POST /workers/{uuid}/ping	Worker heartbeat/ping (also reactivates unregistered workers)
WorkersApi	workers_controller_register	POST /workers/register	Register a new worker
WorkersApi	workers_controller_remove	DELETE /workers/{uuid}	Remove a worker (soft-delete)
WorkersApi	workers_controller_unregister	POST /workers/{uuid}/unregister	Unregister a worker (graceful shutdown)
WorkflowsApi	compare_workflow_versions	GET /workflow-definition/compare	Compare two versions of a workflow
WorkflowsApi	find_workflow_definition_page	GET /workflow-definition/page	Retrieve a page of workflow definitions without their documents
WorkflowsApi	find_workflow_execution_jobs	GET /workflow-execution/{id}/jobs	Retrieve a page of the jobs of one workflow execution
WorkflowsApi	find_workflow_execution_logs	GET /workflow-execution/{id}/logs	Retrieve a page of the log lines of one workflow execution
WorkflowsApi	find_workflow_execution_page	GET /workflow-execution/page	Retrieve a page of workflow executions
WorkflowsApi	publish_workflow	POST /workflow-definition/publish	Publish a workflow definition
WorkflowsApi	restore_workflow_definition	POST /workflow-definition/{id}/restore	Restore a soft-deleted workflow definition by ID
WorkflowsApi	workflow_definition_controller_find_all	GET /workflow-definition	Retrieve all workflow definitions
WorkflowsApi	workflow_definition_controller_find_by_sem_ver_string	GET /workflow-definition/find-by-semver/{semver}	Retrieve the closest matching workflow definition for a semantic version string
WorkflowsApi	workflow_definition_controller_find_one	GET /workflow-definition/{id}	Retrieve a workflow definition by ID
WorkflowsApi	workflow_definition_controller_soft_delete	DELETE /workflow-definition/{id}	Soft-delete a workflow definition by ID
WorkflowsApi	workflow_execution_controller_abort	DELETE /workflow-execution/{id}	Abort a running workflow execution (not implemented)
WorkflowsApi	workflow_execution_controller_execute	POST /workflow-execution	Add a workflow execution to the table
WorkflowsApi	workflow_execution_controller_find_all	GET /workflow-execution	Retrieve all workflow executions
WorkflowsApi	workflow_execution_controller_find_all_active	GET /workflow-execution/active	Retrieve all active workflow executions
WorkflowsApi	workflow_execution_controller_find_all_by_state	GET /workflow-execution/state/{state}	Retrieve all workflow executions by state
WorkflowsApi	workflow_execution_controller_find_latest_per_workflow	GET /workflow-execution/latest	Retrieve the latest execution of each workflow
WorkflowsApi	workflow_execution_controller_find_one	GET /workflow-execution/id/{id}	Retrieve a specific workflow execution by ID
WorkflowsApi	workflow_execution_controller_remediation_ledger	GET /workflow-execution/{id}/remediation	Remediation view of an unsafe execution
WorkflowsApi	workflow_execution_controller_remediation_resolve	POST /workflow-execution/{id}/remediation/resolve	Resolve executed steps of an unsafe execution by human attestation
WorkflowsApi	workflow_execution_controller_remediation_rollback	POST /workflow-execution/{id}/remediation/rollback	Roll back executed steps of an unsafe execution
WorkflowsApi	workflow_execution_controller_remediation_write_back	POST /workflow-execution/{id}/remediation/write-back	Retry the refused write-back of an unsafe execution

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

JWT

Type: Bearer authentication (JWT)

Author

Metadata

Release files for neops_workflow_engine_client 0.46.0b4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for neops_workflow_engine_client 0.46.0b4
File	Size	Uploaded	Provenance	Actions
neops_workflow_engine_client-0.46.0b4.tar.gz	147.3 kB	Nov 6, 2026	Without provenance	Details for neops_workflow_engine_client-0.46.0b4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for neops_workflow_engine_client 0.46.0b4
File	Interpreter	ABI	Platform	Actions Reset
neops_workflow_engine_client-0.46.0b4-py3-none-any.whl 342.8 kB Nov 6, 2026 Without provenance	Python 3	none	any	Details for neops_workflow_engine_client-0.46.0b4-py3-none-any.whl

Total release size: 490.1 kB

Release files / neops_workflow_engine_client-0.46.0b4.tar.gz

Download URL	neops_workflow_engine_client-0.46.0b4.tar.gz
Size	147.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`142d822b3e33f4e31d562e4340e3d77d00947d39342f3037836347588bc5c5b9`
BLAKE2b-256 checksum How to use checksums	`b5ad77df9efa4b4dd90a650161ac9ef8e9f7e62ca3198c323c0284669577f07f`
Upload date	Nov 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.5 CPython/3.15.2 Linux/6.8.0-142-generic`

Release files / neops_workflow_engine_client-0.46.0b4-py3-none-any.whl

Download URL	neops_workflow_engine_client-0.46.0b4-py3-none-any.whl
Size	342.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b4bc1ae5a5467d4262ae00505a817330355e473d8bbe2e49dc88812083d6986d`
BLAKE2b-256 checksum How to use checksums	`978a84d9f4d775c19aaeaa7b94d04c068fce801d9732ca2fd69dd22b11fa5dcb`
Upload date	Nov 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.5 CPython/3.15.2 Linux/6.8.0-142-generic`

Security for neops_workflow_engine_client 0.46.0b4

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

0.46.0

Nov 8, 2026 2 release files No provenance

This release

Pre-release

0.46.0b4 This release

Nov 6, 2026 2 release files No provenance