flows

Deploy Flow

Deploy Flow to an Environment.

Set the deployed version for the specified Environment. This Flow will be used for calls made to the Flow in this Environment.

post/flows/{id}/environments/{environment_id}

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/flows/{id}/environments/{environment_id}
  • Auth: API key in header X-API-KEY

Path parameters

idstring required

Unique identifier for Flow.

environment_idstring required

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstring required

Unique identifier for the specific version of the Flow.

Response

Successful Response

pathstring required

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

idstring required

Unique identifier for the Flow.

directory_idstring

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

attributesobject required

A key-value object identifying the Flow Version.

version_namestring

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

version_descriptionstring

Description of the Version.

namestring required

Name of the Flow.

descriptionstring

Description of the Flow.

schemaobject

The JSON schema for the File.

readmestring

Long description of the file.

tagsstring[]

List of tags associated with the file.

version_idstring required

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

type'flow'
created_atstring date-time required
updated_atstring date-time required
created_byunknown
last_used_atstring date-time required
version_logs_countinteger required

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

Changes

No recorded changes to this operation across all 1 revision of this API.