APIFlows

Get Flow

Retrieve the Flow with the given ID.

By default, the deployed version of the Flow is returned. Use the query parameters version_id or environment to target a specific version of the Flow.

Path parameters

idstringRequired

Unique identifier for Flow.

Headers

X-API-KEYstringRequired

Query parameters

version_idstringOptional

A specific Version ID of the Flow to retrieve.

environmentstringOptional

Name of the Environment to retrieve a deployed Version from.

Response

Successful Response

pathstring

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

idstring

Unique identifier for the Flow.

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
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.

version_namestringOptional

Unique name for the Flow version. Version names must be unique for a given Flow.

version_descriptionstringOptional

Description of the Version.

descriptionstringOptional

Description of the Flow.

readmestringOptional

Long description of the file.

tagslist of stringsOptional

List of tags associated with the file.

type"flow"OptionalDefaults to flow
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