Commit a Flow Version

POST

Commit a version of the Flow with a commit message.

If the version is already committed, an exception will be raised.

Path parameters

idstringRequired

Unique identifier for Flow.

version_idstringRequired

Unique identifier for the specific version of the Flow.

Request

This endpoint expects an object.
commit_messagestringRequired

Message describing the changes made.

Response

This endpoint returns an object.
pathstring

Path of the Flow, including the name, which is used as a unique identifier.

idstring

Unique identifier for the Flow. Starts with fl_.

attributesmap from strings to any

A key-value object identifying the Flow Version.

namestring

Name of the Flow.

version_idstring

Unique identifier for the specific Flow Version. If no query params provided, the default deployed Flow Version is returned.

created_atdatetime
updated_atdatetime
statusenum
Allowed values: uncommittedcommitteddeleted

The status of the Flow Version.

last_used_atdatetime
version_logs_countinteger

The number of logs that have been generated for this Flow Version

directory_idstringOptional

ID of the directory that the file is in on Humanloop.

commit_messagestringOptional

Message describing the changes made. If provided, a committed version of the Flow is created. Otherwise, an uncommitted version is created.

type"flow"Optional
environmentslist of objectsOptional

The list of environments the Flow Version is deployed to.

created_byanyOptional

The user who created the Flow.

evaluator_aggregateslist of objectsOptional

Aggregation of Evaluator results for the Flow Version.

evaluatorslist of objectsOptional

The list of Monitoring Evaluators associated with the Flow Version.

Errors