directories

Update

Update the Directory with the given ID.

patch/directories/{id}

Request

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

Path parameters

idstring required

Unique identifier for Directory. Starts with dir_.

Request body

namestring

Name to set for the directory.

parent_idstring

ID of the parent directory. Specify this to move directories. Starts with dir_.

pathstring

Path to move the directory to, relative to the root directory. Specify this to move directories. Includes name, e.g. path/to/directory.

Response

Successful Response

idstring required

String ID of directory. Starts with dir_.

parent_idstring

ID of the parent directory. Will be None if the directory is the root directory. Starts with dir_.

namestring required

Name of the directory.

descriptionstring

Description of the directory.

pathstring required

Path to the directory, relative to the root directory. Includes name, e.g. path/to/directory.

readmestring

Long description of the directory.

tagsstring[] required

List of tags associated with the directory.

created_atstring date-time required
updated_atstring date-time required

Changes

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