Skip to main content
POST
/
v1
/
folders
Create Folder
curl --request POST \
  --url https://api.getmaxim.ai/v1/folders \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '{
  "workspaceId": "<string>",
  "name": "<string>",
  "entityType": "WORKFLOW",
  "parentId": "<string>",
  "config": "<any>"
}'
{
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "name": "<string>",
    "entityType": "WORKFLOW",
    "parentId": "<string>",
    "config": "<any>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "type": "FOLDER"
  }
}

Authorizations

​
x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
​
workspaceId
string
required

Unique identifier for the workspace

Minimum length: 1
​
name
string
required

Name of the folder

Minimum length: 1
​
entityType
enum<string>
required

Type of entity for the folder

Available options:
WORKFLOW,
PROMPT_CHAIN,
DATASET,
PROMPT,
CONTEXT_SOURCE,
PROMPT_COMPARISONS,
LOG_REPOSITORY,
PROMPT_TOOL
​
parentId
string | null

ID of the parent folder, if any

​
config
any

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

Response

Folder created successfully

​
data
object
required