---
updatedAt: 2026-09-03T15:19:15.000Z
agentTools:
  projectIndex: https://docs.pennsieve.io/llms.txt
---

# creates a new package

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Pennsieve Swagger",
    "version": "1.0.0",
    "description": "Swagger documentation for the Pennsieve api",
    "termsOfService": "https://docs.pennsieve.io/docs/pennsieve-terms-of-service",
    "contact": {
      "name": "Pennsieve Team",
      "url": "https://docs.pennsieve.io",
      "email": "support@pennsieve.net"
    },
    "license": {
      "name": "All rights reserved",
      "url": "https://docs.pennsieve.io"
    }
  },
  "paths": {
    "/packages/": {
      "post": {
        "operationId": "createPackage",
        "summary": "creates a new package",
        "tags": [
          "Packages"
        ],
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePackageRequest"
              }
            }
          },
          "description": "package to create",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/PackageDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "//api.pennsieve.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "description": "",
        "name": "api_key",
        "in": "query"
      }
    },
    "schemas": {
      "PackageState": {
        "type": "object",
        "properties": {}
      },
      "WrappedPackage": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "nodeId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "packageType": {
            "$ref": "#/components/schemas/PackageType"
          },
          "datasetId": {
            "type": "string"
          },
          "datasetNodeId": {
            "type": "string"
          },
          "ownerId": {
            "type": "integer",
            "format": "int32"
          },
          "state": {
            "$ref": "#/components/schemas/PackageState"
          },
          "parentId": {
            "type": "integer",
            "format": "int32"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "intId": {
            "type": "integer",
            "format": "int32"
          },
          "datasetIntId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "required": [
          "id",
          "nodeId",
          "name",
          "packageType",
          "datasetId",
          "datasetNodeId",
          "state",
          "createdAt",
          "updatedAt",
          "intId",
          "datasetIntId"
        ]
      },
      "FileDTO": {
        "type": "object",
        "properties": {
          "content": {
            "$ref": "#/components/schemas/FileContent"
          }
        },
        "required": [
          "content"
        ]
      },
      "UUID": {
        "type": "object",
        "properties": {
          "mostSigBits": {
            "type": "integer",
            "format": "int64"
          },
          "leastSigBits": {
            "type": "integer",
            "format": "int64"
          }
        },
        "required": [
          "mostSigBits",
          "leastSigBits"
        ]
      },
      "ModelPropertyDTO": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "$ref": "#/components/schemas/Object"
          },
          "dataType": {
            "type": "string"
          },
          "fixed": {
            "type": "boolean"
          },
          "hidden": {
            "type": "boolean"
          },
          "display": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value",
          "dataType",
          "fixed",
          "hidden",
          "display"
        ]
      },
      "ChannelDTO": {
        "type": "object",
        "properties": {
          "content": {
            "$ref": "#/components/schemas/WrappedChannel"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModelPropertiesDTO"
            }
          }
        },
        "required": [
          "content",
          "properties"
        ]
      },
      "WrappedChannel": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "packageId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "start": {
            "type": "integer",
            "format": "int64"
          },
          "end": {
            "type": "integer",
            "format": "int64"
          },
          "unit": {
            "type": "string"
          },
          "rate": {
            "type": "number",
            "format": "double"
          },
          "channelType": {
            "type": "string"
          },
          "group": {
            "type": "string"
          },
          "lastAnnotation": {
            "type": "integer",
            "format": "int64"
          },
          "spikeDuration": {
            "type": "integer",
            "format": "int64"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "packageId",
          "name",
          "start",
          "end",
          "unit",
          "rate",
          "channelType",
          "lastAnnotation",
          "createdAt"
        ]
      },
      "CreatePackageRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "externalLocation": {
            "type": "string"
          },
          "parent": {
            "type": "string"
          },
          "dataset": {
            "type": "string"
          },
          "packageType": {
            "$ref": "#/components/schemas/PackageType"
          },
          "state": {
            "$ref": "#/components/schemas/PackageState"
          },
          "owner": {
            "type": "string"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModelPropertyRO"
            }
          }
        },
        "required": [
          "name",
          "dataset",
          "packageType",
          "properties"
        ]
      },
      "PackageType": {
        "type": "object",
        "properties": {}
      },
      "Object": {
        "type": "object",
        "properties": {}
      },
      "FileObjectType": {
        "type": "object",
        "properties": {}
      },
      "FileType": {
        "type": "object",
        "properties": {}
      },
      "FileChecksum": {
        "type": "object",
        "properties": {
          "chunkSize": {
            "type": "integer",
            "format": "int64"
          },
          "checksum": {
            "type": "string"
          }
        },
        "required": [
          "chunkSize",
          "checksum"
        ]
      },
      "ModelPropertiesDTO": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModelPropertyDTO"
            }
          }
        },
        "required": [
          "category",
          "properties"
        ]
      },
      "Json": {
        "type": "object",
        "properties": {}
      },
      "ExternalFileDTO": {
        "type": "object",
        "properties": {
          "packageId": {
            "type": "integer",
            "format": "int32"
          },
          "location": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "packageId",
          "location",
          "createdAt",
          "updatedAt"
        ]
      },
      "ModelPropertyRO": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "dataType": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "fixed": {
            "type": "boolean"
          },
          "hidden": {
            "type": "boolean"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "PackageDTO": {
        "type": "object",
        "properties": {
          "content": {
            "$ref": "#/components/schemas/WrappedPackage"
          },
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModelPropertiesDTO"
            }
          },
          "parent": {
            "$ref": "#/components/schemas/PackageDTO"
          },
          "objects": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/FileDTO"
              }
            }
          },
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageDTO"
            }
          },
          "ancestors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PackageDTO"
            }
          },
          "channels": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChannelDTO"
            }
          },
          "externalFile": {
            "$ref": "#/components/schemas/ExternalFileDTO"
          },
          "storage": {
            "type": "integer",
            "format": "int64"
          },
          "extension": {
            "type": "string"
          }
        },
        "required": [
          "content",
          "properties",
          "children"
        ]
      },
      "FileContent": {
        "type": "object",
        "properties": {
          "packageId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "fileType": {
            "$ref": "#/components/schemas/FileType"
          },
          "filename": {
            "type": "string"
          },
          "s3bucket": {
            "type": "string"
          },
          "s3key": {
            "type": "string"
          },
          "objectType": {
            "$ref": "#/components/schemas/FileObjectType"
          },
          "size": {
            "type": "integer",
            "format": "int64"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "md5": {
            "type": "string"
          },
          "checksum": {
            "$ref": "#/components/schemas/FileChecksum"
          },
          "properties": {
            "$ref": "#/components/schemas/Json"
          },
          "assetType": {
            "type": "string"
          },
          "provenanceId": {
            "$ref": "#/components/schemas/UUID"
          },
          "published": {
            "type": "boolean"
          },
          "publishedS3VersionId": {
            "type": "string"
          },
          "scanStatus": {
            "type": "string"
          },
          "scannedAt": {
            "type": "string",
            "format": "date-time"
          },
          "scanEngine": {
            "type": "string"
          },
          "scanSkipReason": {
            "type": "string"
          }
        },
        "required": [
          "packageId",
          "name",
          "fileType",
          "filename",
          "s3bucket",
          "s3key",
          "objectType",
          "size",
          "createdAt",
          "updatedAt",
          "id",
          "published"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```