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_idstring or null
ID of the directory that the file is in on Humanloop.
version_namestring or null
Unique name for the Flow version. Version names must be unique for a given Flow.
version_descriptionstring or null
Description of the Version.
descriptionstring or null
Description of the Flow.
schemamap from strings to any or null
The JSON schema for the File.
readmestring or null
Long description of the file.
tagslist of strings or null
List of tags associated with the file.
type"flow" or nullDefaults to flow
environmentslist of objects or null
The list of environments the Flow Version is deployed to.
created_byany or null
The user who created the Flow.
evaluator_aggregateslist of objects or null
Aggregation of Evaluator results for the Flow Version.
evaluatorslist of objects or null
The list of Monitoring Evaluators associated with the Flow Version.

Errors