API Documentation

Release:

1.0.0

Date:

Sep 26, 2025

This reference manual details functions, modules and objects included in KAPPA-Automate Python SDK, describing what they are and what they do.

Common Extension Development API

str_to_datetime(time_string)	Converts a string to UTC date/time.
datetime_to_str(date)	Converts a date/time to string with UTC format.
datetime_to_utc(date)	Converts a given date/time to UTC date/time.
Connection(server_address[, proxies, ...])	Connection to the KAPPA Automate instance.
Field(field_id, name, asset, field_dto, ...)	Field object.
KWModuleEnum(value[, names, module, ...])	KW Module type enumeration.
ModelActionEnum(value[, names, module, ...])	Model action enumeration.
ScriptResult(is_success, message)	KW script run result.
Well(field_id, well_group_id, well_id, name, ...)	Well object.
WellGroup(well_group_id, field_id, name, ...)	Well group object.
Document(field_id, well_group_id, well_id, ...)	KW document object.
Data(field_id, well_id, data_id, vector_id, ...)	Data object.
UserTask(field_id, well_id, ...)	User task object.
DataKindEnum(value[, names, module, ...])	Data kind enumeration.
Vector(dates, values[, first_x, vector_id])	Vector object.
DocumentVector(dates, values, name, measure, ...)	KW document vector object.
Analysis(field_id, well_group_id, well_id, ...)	KW analysis object.
Event(event_id, object_id, object_type, ...)	KAPPA Automate event.
EventBus(service_address, access_token[, ...])	KAPPA Automate event bus.
AnalysisResults(xml_string)	Wrapper for the results.xml from KW document.
RestAPI(configuration[, oath_service])	A REST API facade for KAPPA Automate.
UnitEnum(value[, names, module, qualname, ...])	Unit enumeration.
UnitConverter(unit_dto)	Units converter is a static helper that converts a given value from and to internal units.
WellPropertyContainer(field_id, well_id, ...)	Well property container object.
IncrementalPTA(field_id, well_id, ...)	Incremental PTA object.
IncrementalRTA(user_task_id, name, ...)	Incremental RTA object.
File(field_id, well_group_id, well_id, ...)	KA file object.
Plot(field_id, well_id, plot_id, plot_name, ...)	Plot object.
PlotChannel(field_id, data_types_catalog[, ...])	Build a PlotChannel dto for the Plot object.
Metadata(user_measure_id, is_by_step, ...[, ...])	Metadata object.
ServiceEnum(value[, names, module, ...])	Represents various service categories in a system using enumeration.
DataEnumerator(settings[, rest_api])	Python wrapper for a Dataset Enumerator.
DataEnumeratorSettings([time_range, ...])	Python wrapper for the DataProductSettings.
ExtrapolationMethodEnum(value[, names, ...])	An enumeration of the extrapolation methods.
InterpolationMethodEnum(value[, names, ...])	An enumeration of the interpolation methods.
TimeRangeEnum(value[, names, module, ...])	An enumeration of the time range.
DataEnumeratorPoint(date, values)	A time-based slice of results produced by the DataEnumerator.
DataEnumeration(vectors, last_points)	Result produced by the DataEnumerator.
PlotDataTypesEnum(value[, names, module, ...])	Unit enumeration.
LineAspectEnum(value[, names, module, ...])
SymbolAspectEnum(value[, names, module, ...])
MeasureEnum(value[, names, module, ...])	Measure enumeration.
DrawingStyle(value[, names, module, ...])
NumericValue(measure, value)
DataType(alias, name, measure[, comment, ...])	Data Type object.
IncrementalPTAType(value[, names, module, ...])
IncrementalRTAType(value[, names, module, ...])
SaveStrategyEnum(value[, names, module, ...])	KW save strategy for IPTA workflows
GaugeLoadingStrategy(value[, names, module, ...])	KW Gauge Loading Strategy.
WorkflowImproveSettings(...[, ...])
IptaParameter(value[, names, module, ...])
IrtaParameter(value[, names, module, ...])
WellProductionTypeEnum(value[, names, ...])	Well production type enumeration
WellProperty(alias, name, well_property_type)	Well Property object.
WellPropertyType(value[, names, module, ...])
TimeFormatEnum(value[, names, module, ...])	Time format Enum
AutomationStatus(value[, names, module, ...])
ShutIn(start_date, end_date, is_reference, ...)	Class to store any shutin
PTAExtraction(start_date, end_date, ...)	Class to store the result of a PTA Extraction from Shut-in.
ShutInList([shutins])	Class to store a List of Shut-in
compute_goodness_of_fit_from_vectors(...[, ...])	Compute the goodness of fit from vector objects
calculate_cumulative_production_rate_from_vector(vector)	Calculate the cumulative production rate from a rate vector
get_closest_value_at_date_from_vector(...)	Get the closest value at a specific date from a vector using highly optimized approach
compute_goodness_of_fit(reference_values, values)	Compute the goodness of fit from vector objects
remove_nan_from_vector(vector[, value])	Removes NaN or None entries from the input vector.
apply_factor(vector, value)	Applies a scaling factor to the values of a vector.
trunc_vector(vector, min_elapsed_time[, ...])	Truncates the provided vector based on the specified elapsed time constraints.
shift_vector(vector, value)	Shift a vector by applying a scaling factor and modifying elapsed times.
interpolate_vectors(vectors[, ...])	Interpolate a list of vectors based on a specified interpolation method, an optional reference vector, and an optional data enumerator.
wait_document_preprocessing(rest_api, ...)	Wait until the document preprocessing is finished
FieldWellPropertiesCatalog(field_id, ...)	Field Well Properties catalog
FieldDataTypesCatalog(field_id, id, ...)	Field Data Types catalog
DenoisingPreSamplingTypeEnum(value[, names, ...])
FilterTypeEnum(value[, names, module, ...])
ResultsXMLParsingException(message)
ProductionFolder(field_id, well_id, id, ...)
WellProductionEnum
TimezoneEnum(value[, names, module, ...])	Timezone enumeration.
CoordinateSystemEnum(value[, names, module, ...])
CountryEnum(value[, names, module, ...])	Country enumeration.
LookForEnum(value[, names, module, ...])
InputTypeEnum(value[, names, module, ...])
ReplaceByEnum(value[, names, module, ...])
RateCorrectionOptionEnum(value[, names, ...])
SimplifyMethodEnum(value[, names, module, ...])
ShutInTypesEnum(value[, names, module, ...])
ShutInCategoriesEnum(value[, names, module, ...])
DenoisingThresholdTypeEnum(value[, names, ...])
get_value_at_date_from_vector(vector, ...)	Get the value at a specific date from a vector
VectorElement(date, value, elapsed_time)

KW Development API

FlowCorrelationEnum(value[, names, module, ...])
GasLiftPropertiesEnum(value[, names, ...])
IntakePropertiesEnum(value[, names, module, ...])
TemperaturePropertiesEnum(value[, names, ...])
WellIntakeParser(xml_string)	Parses XML Well Intake from KW document's well intake 5.50
WellIntakeType(value[, names, module, ...])
TrajectoryEnum(value[, names, module, ...])
GeometryPropertiesEnum(value[, names, ...])
FlowPathEnum(value[, names, module, ...])
ImproveTarget(target_type, global_weight, ...)	Class for wrapping an ImproveTarget in an KW XML document
ModelParser(xml_string)	Performs various operations with XML representation of KW models
ModelParameter(parameter_type, conditions)	An immutable ModelParameter object Describes an identifier for a parameter in KWKAModel xml.
ModelParameterEnum(value[, names, module, ...])
ModelParameterType(value[, names, module, ...])
is_length_parameter(model_parameter)	Returns if the parameter is a length parameter : well length, boundary distance etc.
is_skin_parameter(model_parameter)	Returns if the parameter is a skin parameter
create_derived_parameter(...)	Creates a derived parameter from a basic one :param base_model_parameter: :type base_model_parameter: basic parameter :param additional_conditions: :type additional_conditions: additional conditions to add (layerId, fracture index, etc.)
ModelParameterWithValues(...)	An immutable ModelParameterWithValues object Describes an identifier for a parameter in KWKAModel XML with it list of values
ModelParameters(analysis_id)	A class to store all parameters value to update a KWKAModel XML model
ImproveVariable(model_parameter, ...)	ImproveVariable object.

KEG5 Development API

DataSet(name, x, y, values)
ModelParser(xml_string)	Parses XML from KEG5 KW document's model
VectorialReservoir(perm_id, porosity_id, ...)
Point3D(x, y, z)	Class to store coordinates of a 3D point
Keg5WellPropertyInputs(name, uwi, x, y, ...)	Class to store the properties to use to create a well in KEG5

Wellbore Development API

Wellbore(id, name, technical_object_id, ...)
WellboreGeometry(start_date, root_pipe[, ...])
WellborePipe(pipe_type, sections)	Class representing a pipe within a wellbore.
WellborePipeSection(name, length, ...[, ...])
WellborePerforation(start_date, ...)
DepthCollection(md_start, md_end, is_closed)

PVT Development API

BlackOilPVTResults(density, viscosity, ...)
MixtureResultsEos([saturation_point, ...])
EosPVTResults(density, viscosity, ...[, ...])
ThermalResults(enthalpy, entropy, cp, ...)
MixtureResultsBlackOil([bubble_point, ...])
PVT(field_id, well_id, id, name, ...)

User Task Development API

DataCommandService(data_api, data_dto_converter)	Python wrapper for a Data Command Service.
Context([field_id, well_id, context_dict, ...])	User task context.
DataQueryService(data_api, unit_converter)	Python wrapper for a Data Query Service.
Services(*args, **kwargs)	User task services.
Log(*args, **kwargs)	User task logger.
Scheduler()	Scheduler.
EventPublisher(*args, **kwargs)	Event publisher.
Parameters(input_parameters, output_parameters)	User task parameters.
InputParameters(parameters_dictionary)	Input parameters container.
OutputParameters(parameters_dictionary)	Output parameters container.
ParametersDictionary(*args, **kwargs)	Defines a protocol for a dictionary-like object with specific parameter types and behavior.
Redefinition(mode[, date])	The redefinition options of the user task.
RedefinitionModeEnum(value[, names, module, ...])	Redefinition modes enumeration.

LogSimulated(*args, **kwargs)	User Task logging simulation.
EventPublisherSimulated(*args, **kwargs)	Event publishing simulation.
UserTaskInstance(connection, context[, ...])	Simulated user task instance.
ServicesSimulated(connection, context, ...)
SimulatedUserTask(well, name, outputs)	User task object.
ParametersDictionarySimulation(yaml_definition)