Create Folder

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Request Body

application/jsonOptional

workspaceIdRequiredstring

Unique identifier for the workspace

Minimum length: 1

nameRequiredstring

Name of the folder

Minimum length: 1

entityTypeRequiredstring

Type of entity for the folder

Value in:

"WORKFLOW" | "PROMPT_CHAIN" | "DATASET" | "PROMPT" | "CONTEXT_SOURCE" | "PROMPT_COMPARISONS" | "LOG_REPOSITORY" | "PROMPT_TOOL"

parentIdstring

ID of the parent folder, if any

configunknown

Additional configuration for the folder. Can be any key-value pair.

curl -X POST "https://api.getmaxim.ai/v1/folders" \
  -H "x-maxim-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "string",
    "name": "string",
    "entityType": "WORKFLOW",
    "parentId": "string",
    "config": null
  }'

Folder created successfully

{
  "data": {
    "id": "string",
    "workspaceId": "string",
    "name": "string",
    "entityType": "WORKFLOW",
    "parentId": "string",
    "config": null,
    "createdAt": "string",
    "updatedAt": "string",
    "type": "FOLDER"
  }
}

Create Folder

Authorization

Request Body

Response

TypeScript