Create | Humanloop Docs

Creates a Directory.

Authentication

X-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

namestringOptional

Name of the directory to create.

parent_idstringOptional

ID of the parent directory. Starts with dir_.

pathstringOptional

Path to create the directory in, relative to the root directory. If the path does not exist, it will be created. Includes name, e.g. path/to/directory.

Response

Successful Response

idstring

String ID of directory. Starts with dir_.

namestring

Name of the directory.

pathstring

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

tagslist of strings

List of tags associated with the directory.

created_atdatetime

updated_atdatetime

parent_idstring

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

descriptionstring

Description of the directory.

readmestring

Long description of the directory.

Errors

422

Create Directories Post Request Unprocessable Entity Error

API Key authentication via header

This endpoint expects an object.

Name of the directory to create.

ID of the parent directory. Starts with dir_.

Path to create the directory in, relative to the root directory. If the path does not exist, it will be created. Includes name, e.g. path/to/directory.

String ID of directory. Starts with dir_.

Name of the directory.

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

List of tags associated with the directory.

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

Description of the directory.

Long description of the directory.

$	curl -X POST https://api.humanloop.com/v5/directories \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "id",
3	"name": "name",
4	"path": "path",
5	"tags": [
6	"tags"
7	],
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"parent_id": "parent_id",
11	"description": "description",
12	"readme": "readme"
13	}

$	curl -X POST https://api.humanloop.com/v5/directories \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "id",
3	"name": "name",
4	"path": "path",
5	"tags": [
6	"tags"
7	],
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"parent_id": "parent_id",
11	"description": "description",
12	"readme": "readme"
13	}