Skip to main content
POST
/
stack
/
create
Create Stack
curl --request POST \
  --url https://api.stax.ai/stack/create \
  --header 'Content-Type: application/json' \
  --cookie authToken= \
  --data '
{
  "stackPath": "<string>",
  "baseStack": "<string>",
  "inheritSharingFrom": "<string>"
}
'
{
  "success": true,
  "stack": {
    "_id": "<string>",
    "path": "<string>",
    "template": "<string>",
    "team": "<string>",
    "baseName": "<string>",
    "base": "<string>",
    "restrict": true,
    "access": [
      "<string>"
    ],
    "pinned": true,
    "hideHint": true,
    "enabled": true,
    "lastModified": "2023-11-07T05:31:56Z",
    "numDocuments": 123,
    "numUnread": 123,
    "keys": [
      "<string>"
    ],
    "dataTypes": [
      {
        "key": "<string>",
        "dataType": "text"
      }
    ],
    "rules": {
      "enabled": true,
      "match": {
        "mode": "all",
        "source": [
          "<string>"
        ],
        "name": [
          "<string>"
        ],
        "phrases": [
          "<string>"
        ]
      }
    },
    "trainer": {
      "manualTrigger": true,
      "isTraining": true,
      "lastTrained": "2023-11-07T05:31:56Z"
    },
    "numMovedFiles": 123,
    "pipeline": [
      {
        "module": "<string>",
        "config": [
          {
            "label": "<string>",
            "value": {}
          }
        ],
        "locked": true,
        "trainer": {
          "usage": 123,
          "lastTrained": "2023-11-07T05:31:56Z",
          "training": true,
          "config": [
            {
              "label": "<string>",
              "value": {}
            }
          ],
          "data": {}
        },
        "usage": 123,
        "limit": 123,
        "history": [
          {
            "timestamp": "2023-11-07T05:31:56Z",
            "modifiedBy": "<string>",
            "labels": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "locked": true,
    "forms": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ]
  }
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Body

application/json
stackPath
string
required

Path for the stack (directory components separated with /)

baseStack
string

Base stack ID to inherit from

inheritSharingFrom
string

Stack path to inherit sharing settings from

Response

Stack created successfully

success
boolean
stack
object