Create a folder

POST/folders

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Request body

requiredapplication/json

namestringrequired

typestring

default: "document"

Allowed:documenttemplate

parent_idstring

visibilitystring

default: "everyone"

Allowed:everyonemembersrestricted

pinnedboolean

default: false

Responses

201

Created

idstringrequired

namestringrequired

typestringrequired

Allowed:documenttemplate

parent_idstring | nullrequired

visibilitystringrequired

Allowed:everyonemembersrestricted

pinnedbooleanrequired

created_atstring<date-time>required

updated_atstring<date-time>required

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

namestring*typestringparent_idstringvisibilitystringpinnedboolean

Request

curl -X POST "https://api.seal.nyc/api/v1/folders" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "type": "document",
  "parent_id": "string",
  "visibility": "everyone",
  "pinned": false
}'

const response = await fetch("https://api.seal.nyc/api/v1/folders", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"type\": \"document\",\n  \"parent_id\": \"string\",\n  \"visibility\": \"everyone\",\n  \"pinned\": false\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/folders",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"type\": \"document\",\n  \"parent_id\": \"string\",\n  \"visibility\": \"everyone\",\n  \"pinned\": false\n}",
)

Response

{
  "id": "string",
  "name": "string",
  "type": "document",
  "parent_id": "string",
  "visibility": "everyone",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}