curl -X POST "https://nunu.ai/api/v1/project/your-project-id/test-folders" \
-H "X-Api-Key: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"test_folder": {
"name": "smoke",
"parent_path": "regression",
"description": "Critical-path smoke tests",
"tags": ["nightly"],
"create_intermediate_parents": true
}
}'
{
"id": "f01a3b1c-9d2e-4f05-8c7a-1a2b3c4d5e6f",
"name": "smoke",
"path": "regression/smoke",
"parent_folder_id": "e10b2c3d-4e5f-6789-abcd-ef0123456789",
"parent_path": "regression",
"created_intermediate_paths": ["regression"]
}
Test Folders
Create Test Folder
Create one folder in the test repository. The parent is addressed by path (preferred) or id, and defaults to the root.
POST
/
project
/
{projectId}
/
test-folders
curl -X POST "https://nunu.ai/api/v1/project/your-project-id/test-folders" \
-H "X-Api-Key: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"test_folder": {
"name": "smoke",
"parent_path": "regression",
"description": "Critical-path smoke tests",
"tags": ["nightly"],
"create_intermediate_parents": true
}
}'
{
"id": "f01a3b1c-9d2e-4f05-8c7a-1a2b3c4d5e6f",
"name": "smoke",
"path": "regression/smoke",
"parent_folder_id": "e10b2c3d-4e5f-6789-abcd-ef0123456789",
"parent_path": "regression",
"created_intermediate_paths": ["regression"]
}
Permission Required:
project:edit-tests"regression/smoke") rather than UUID, so the parent is normally given as
parent_path. Omit both parent fields to create the folder at the root.
The resulting path is the string accepted by folder_path in
Create Test,
Update Test, and
List Tests — so this endpoint is what lets a
client build the folder it wants to file new tests under.
Request Body
object
required
Folder definition
Show test_folder properties
Show test_folder properties
string
required
Folder name. Cannot contain
/, and cannot have leading or trailing
whitespace — both would make the folder unaddressable by path.string
Parent folder addressed by path.
null or "/" means the root. Mutually
exclusive with parent_folder_id.string
Pre-resolved parent folder UUID, as returned by
List Test Folders.
Mutually exclusive with
parent_path.string
Optional description shown in the folder details dialog.
string[]
Optional tags applied to the folder.
boolean
default:"false"
When
parent_path names a folder that does not exist yet, create the
missing segments instead of returning 404. Defaults to false so a typo
surfaces as an error rather than silently building a new hierarchy.Response
Returns the newly created folder with status201.
string
required
Folder UUID
string
required
Folder name (just the leaf segment)
string
required
Resolved folder path (e.g.
"regression/smoke")string
Parent folder UUID, or
null for top-level foldersstring
required
Resolved parent path, or
"/" for top-level foldersstring[]
required
Parents that had to be created on the way to the requested one. Empty unless
create_intermediate_parents was set.Errors
| Status | When |
|---|---|
400 | Invalid folder name, or both parent_path and parent_folder_id supplied |
404 | parent_path does not exist and create_intermediate_parents was not set |
409 | A folder with that name already exists in the same parent |
curl -X POST "https://nunu.ai/api/v1/project/your-project-id/test-folders" \
-H "X-Api-Key: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"test_folder": {
"name": "smoke",
"parent_path": "regression",
"description": "Critical-path smoke tests",
"tags": ["nightly"],
"create_intermediate_parents": true
}
}'
{
"id": "f01a3b1c-9d2e-4f05-8c7a-1a2b3c4d5e6f",
"name": "smoke",
"path": "regression/smoke",
"parent_folder_id": "e10b2c3d-4e5f-6789-abcd-ef0123456789",
"parent_path": "regression",
"created_intermediate_paths": ["regression"]
}
Authorizations
API key for authentication
Path Parameters
The project ID. You can copy it from the project settings page or the project URL in the dashboard.
Body
application/json
Show child attributes
Show child attributes