flows

Move Flow

Move the Flow to a different path or change the name.

patch/flows/{id}

Request

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

Path parameters

idstring required

Unique identifier for Flow.

Request body

pathstring

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

namestring

Name of the Flow.

directory_idstring

Unique identifier for the Directory to move Flow to. Starts with dir_.

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.