> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an image folder

> Create a new image folder.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const imageFolder = await site.imageFolders().createImageFolder({ title: 'Example title', visibility: 'public' });
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}
```

## In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/create-image-folder.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function createImageFolder(site: SiteClient) {
  return site.imageFolders().createImageFolder({ title: 'Example title', visibility: 'public' });
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/create-image-folder.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { createImageFolder } from '../src/attract/create-image-folder.ts';

const site = createSiteClient();
console.log(await createImageFolder(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/create-image-folder.ts
```

A route handler, a job or a queue worker calls it the same way.

> [accordion] Required parameters
>
> One object, e.g. `createImageFolder({ title })`; leave out the optional fields.
>
> **title** `string` *required*
>
> **Required.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **visibility** `Visibility` *required*
>
> **Required.** Select whether this content is public or private. One of `public`, `loginRequired`.

> [accordion] Optional parameters
>
> **parent** `readonly Readonly\<Record\<string, unknown\>\>[] | null | undefined`
>
> **Optional.** The related `image-folder` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **referenceOnly** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.
>
> **archived** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **folderPath** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Its place in the tree: each folder’s URL name from the top, joined by `/` (`albums/summer`). Set by the site from `_parent` and `title`; a value sent is ignored.
>
> **folderParentId** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. The parent folder’s id, empty at the top. Set by the site from `_parent`; a value sent is ignored.
>
> **slugSegment** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Its own part of `folderPath`, made from its title. Set by the site; a value sent is ignored.
>
> **level** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `0`. How deep it sits: 0 at the top. Set by the site from `_parent`; a value sent is ignored.
>
> **linkedAlbumId** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **linkedFeedId** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **linkedDocId** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

> [accordion] Returns
>
> An `ImageFolder`. ImageFolder content type. Read its properties (`imageFolder.title`): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (`_id` → `id`, `_parent` → `parent`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `Visibility`
>
> **Always sent.** Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **id** `string`
>
> **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **createdAt** `Date`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **parent** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The related `image-folder` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **referenceOnly** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.
>
> **archived** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **folderPath** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Its place in the tree: each folder’s URL name from the top, joined by `/` (`albums/summer`). Set by the site from `_parent` and `title`; a value sent is ignored.
>
> **folderParentId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The parent folder’s id, empty at the top. Set by the site from `_parent`; a value sent is ignored.
>
> **slugSegment** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Its own part of `folderPath`, made from its title. Set by the site; a value sent is ignored.
>
> **level** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How deep it sits: 0 at the top. Set by the site from `_parent`; a value sent is ignored.
>
> **linkedAlbumId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **linkedFeedId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.
>
> **linkedDocId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Only when nothing reached the site (`neverConnected()`); never after a timeout, when it may have landed. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:images:write` (or a master above it: `content:images:all`, `content:all`, `admin:all`). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
* **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) on the client for longer.

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/imageFolders-createImageFolder.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { createImageFolder } from '../src/attract/create-image-folder.ts';

test('imageFolders.createImageFolder', async () => {
  const site = fakeSite();
  await createImageFolder(site);
  site.assertCalled('imageFolders.createImageFolder');
});
```

**Answer with your own values:** fake `imageFolders.createImageFolder` with `factories.ImageFolder({...})`, the fields you give over a valid example.

```ts tests/imageFolders-createImageFolder-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('imageFolders.createImageFolder answers your values', async () => {
  const site = fakeSite({
    'imageFolders.createImageFolder': factories.ImageFolder({ title: 'Your value' })
  });
  const imageFolder = await site.imageFolders().createImageFolder({ title: 'Example title', visibility: 'public' });
  assert.equal(imageFolder.title, 'Your value');
});
```

## Related

> [card] [Get the image folder tree](https://docs.fetchski-attract.com/typescript/reference/image-folders/get-image-folder-tree.md)
>
> `site.imageFolders().getImageFolderTree()`

> [card] [List a folder’s photos](https://docs.fetchski-attract.com/typescript/reference/image-folders/list-image-folder-photos.md)
>
> `site.imageFolders().listImageFolderPhotos()`

> [card] [List image folders](https://docs.fetchski-attract.com/typescript/reference/image-folders/list-image-folders.md)
>
> `site.imageFolders().listImageFolders()`

> [card] [Get an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/get-image-folder.md)
>
> `site.imageFolders().getImageFolder()`

> [card] [Replace an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/replace-image-folder.md)
>
> `site.imageFolders().replaceImageFolder()`

> [card] [Delete an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/delete-image-folder.md)
>
> `site.imageFolders().deleteImageFolder()`

> [card] [POST /image-folder](https://docs.fetchski-attract.com/api-reference/image-folders/create-an-image-folder.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.