> ## 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 a photo feed

> Create a new photo feed.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const photoFeed = await site.photoFeeds().createPhotoFeed({ title: 'Example title', visibility: 'public' })
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "feedConnectionId": "clx8m2k4p0000a1b2c3d4e5f6",
  "feedPrefix": "Example feed prefix",
  "feedLayout": "ymd",
  "slug": "example-slug",
  "visibility": "public",
  "feedDateRule": "recentDays",
  "feedRecentDays": 5,
  "feedYears": 2,
  "feedRangeStart": "2026-10-24",
  "feedRangeEnd": "2026-10-24",
  "feedDistribution": "total",
  "feedTargetCount": 30,
  "feedPerDayCount": 10,
  "feedAvoidRepeats": true,
  "feedSeenLimit": 2000,
  "feedFormat": "webp",
  "feedMaxDimension": 2000,
  "feedQuality": 82,
  "feedAspect": "original",
  "feedAltText": "Example feed alt text",
  "feedEnabled": false,
  "feedInterval": "6",
  "feedRetainMinutes": 30,
  "feedLastRunAt": "2026-10-24T09:30:00.000Z",
  "feedLastStatus": "Example feed last status",
  "feedPhotoCount": 1,
  "feedLastError": "Example feed last error",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}
```

## In your app

A controller answers a route on your app: it calls `createPhotoFeed()` and returns the answer.

**1. Add the controller**

```ts app/controllers/create_photo_feed_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class CreatePhotoFeedController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.photoFeeds().createPhotoFeed({ title: 'Example title', visibility: 'public' })
  }
}
```

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

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const CreatePhotoFeedController = () => import('#controllers/create_photo_feed_controller')

router.post('/photo-feed', [CreatePhotoFeedController])
```

Put it behind your auth middleware (`.use(middleware.auth())`): it acts with your key’s access.

**3. Call it**

Your own page’s form or script sends `POST /photo-feed` and gets back its answer as JSON. Test it, below, calls it.

> [accordion] Required parameters
>
> One object, e.g. `createPhotoFeed({ 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
>
> **feedConnectionId** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Which external photo store to draw from. Connections (bucket, region, keys) are set up once in Connections → Photo storage.
>
> **feedPrefix** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional. The folder inside the bucket the dated folders live under — leave empty when they sit at the top level (e.g. “2026/May/31/…”).
>
> **feedLayout** `FeedLayout | null | undefined`
>
> **Optional.** Leave it out and the site uses `"ymd"`. How deep the dated folders go. The month and day folder NAMES don’t matter — “May”, “05” and “5” are all understood — only the depth. One of `ymd`, `ym`, `y`, `flat`.
>
> **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.
>
> **feedDateRule** `FeedDateRule | null | undefined`
>
> **Optional.** Leave it out and the site uses `"recentDays"`. Which dates this feed is allowed to pull from. Only the folders inside this window are ever listed, so a huge library stays cheap to sample. One of `recentDays`, `thisYear`, `lastYears`, `range`, `all`.
>
> **feedRecentDays** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `5`. Counting today. 5 means today and the four days before it. 1 to 365.
>
> **feedYears** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `2`. Counting this one. 2 means this calendar year and last. 1 to 25.
>
> **feedRangeStart** `Date | string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. From. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **feedRangeEnd** `Date | string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. To. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **feedDistribution** `FeedDistribution | null | undefined`
>
> **Optional.** Leave it out and the site uses `"total"`. Spread samples one target count across as many different days as possible (best for a wide window). Every day takes the same number from each day in the window (best for a daily-update wall). One of `total`, `perDay`.
>
> **feedTargetCount** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `30`. How many photos this feed shows. Each refresh replaces the whole set. 1 to 500.
>
> **feedPerDayCount** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `10`. Taken from every day in the window — 10 from each of the last 5 days is 50 photos. 1 to 200.
>
> **feedAvoidRepeats** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `true`. Remember which photos were used and prefer ones that haven’t been shown lately, so a big library keeps producing new sets. When a date window runs out of unseen photos it reuses the oldest ones rather than showing fewer.
>
> **feedSeenLimit** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `2000`. The size of that memory. Bigger means longer before a photo can repeat; 0 turns the memory off. 0 to 20000.
>
> **feedFormat** `FeedFormat | null | undefined`
>
> **Optional.** Leave it out and the site uses `"webp"`. Every photo is re-encoded on the way in — which also strips camera metadata (location, device) from what the site serves. One of `webp`, `jpeg`.
>
> **feedMaxDimension** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `2000`. Photos larger than this are scaled down. 2000 is plenty for a full-screen lightbox; the gallery tiles use much smaller generated sizes. 320 to 6000.
>
> **feedQuality** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `82`. Encoder quality, 40–100. 82 is a good balance; above 90 grows files fast with little visible gain.
>
> **feedAspect** `FeedAspect | null | undefined`
>
> **Optional.** Leave it out and the site uses `"original"`. Keep each photo’s own proportions (best for the Mosaic and Masonry layouts), or crop everything to one shape for a perfectly uniform wall. Crops are centered on the busiest part of the photo. One of `original`, `1:1`, `4:3`, `3:2`, `16:9`, `4:5`.
>
> **feedAltText** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional. Describes what these photos generally show, for screen readers and the lightbox caption. Applied to each photo as it is imported — leave empty to import them without alt text.
>
> **feedEnabled** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. Master switch. When off, the feed keeps showing its current photos and only refreshes when you run it by hand.
>
> **feedInterval** `FeedInterval | null | undefined`
>
> **Optional.** Leave it out and the site uses `"6"`. How often to fetch a fresh set. Change it anytime — no restart. One of `1`, `2`, `3`, `4`, `6`, `12`, `24`, `48`.
>
> **feedRetainMinutes** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `30`. After a refresh the old photos stop being shown immediately, but their files are kept this long before being deleted — a safety margin for pages already sent to a browser and for CDN caches. 0 deletes them right away. 0 to 10080.
>
> **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.

> [accordion] Returns
>
> A `PhotoFeed`. PhotoFeed content type. Read its properties (`photoFeed.title`): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (`_id` → `id`).
>
> **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.
>
> **feedConnectionId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which external photo store to draw from. Connections (bucket, region, keys) are set up once in Connections → Photo storage.
>
> **feedPrefix** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The folder inside the bucket the dated folders live under — leave empty when they sit at the top level (e.g. “2026/May/31/…”).
>
> **feedLayout** `FeedLayout | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How deep the dated folders go. The month and day folder NAMES don’t matter — “May”, “05” and “5” are all understood — only the depth. One of `ymd`, `ym`, `y`, `flat`; a newer site may send others, so keep a fallback.
>
> **feedDateRule** `FeedDateRule | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which dates this feed is allowed to pull from. Only the folders inside this window are ever listed, so a huge library stays cheap to sample. One of `recentDays`, `thisYear`, `lastYears`, `range`, `all`; a newer site may send others, so keep a fallback.
>
> **feedRecentDays** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Counting today. 5 means today and the four days before it. 1 to 365.
>
> **feedYears** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Counting this one. 2 means this calendar year and last. 1 to 25.
>
> **feedRangeStart** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. From. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **feedRangeEnd** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. To. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **feedDistribution** `FeedDistribution | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Spread samples one target count across as many different days as possible (best for a wide window). Every day takes the same number from each day in the window (best for a daily-update wall). One of `total`, `perDay`; a newer site may send others, so keep a fallback.
>
> **feedTargetCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many photos this feed shows. Each refresh replaces the whole set. 1 to 500.
>
> **feedPerDayCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Taken from every day in the window — 10 from each of the last 5 days is 50 photos. 1 to 200.
>
> **feedAvoidRepeats** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Remember which photos were used and prefer ones that haven’t been shown lately, so a big library keeps producing new sets. When a date window runs out of unseen photos it reuses the oldest ones rather than showing fewer.
>
> **feedSeenLimit** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The size of that memory. Bigger means longer before a photo can repeat; 0 turns the memory off. 0 to 20000.
>
> **feedFormat** `FeedFormat | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Every photo is re-encoded on the way in — which also strips camera metadata (location, device) from what the site serves. One of `webp`, `jpeg`; a newer site may send others, so keep a fallback.
>
> **feedMaxDimension** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Photos larger than this are scaled down. 2000 is plenty for a full-screen lightbox; the gallery tiles use much smaller generated sizes. 320 to 6000.
>
> **feedQuality** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Encoder quality, 40–100. 82 is a good balance; above 90 grows files fast with little visible gain.
>
> **feedAspect** `FeedAspect | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Keep each photo’s own proportions (best for the Mosaic and Masonry layouts), or crop everything to one shape for a perfectly uniform wall. Crops are centered on the busiest part of the photo. One of `original`, `1:1`, `4:3`, `3:2`, `16:9`, `4:5`; a newer site may send others, so keep a fallback.
>
> **feedAltText** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Describes what these photos generally show, for screen readers and the lightbox caption. Applied to each photo as it is imported — leave empty to import them without alt text.
>
> **feedEnabled** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Master switch. When off, the feed keeps showing its current photos and only refreshes when you run it by hand.
>
> **feedInterval** `FeedInterval | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How often to fetch a fresh set. Change it anytime — no restart. One of `1`, `2`, `3`, `4`, `6`, `12`, `24`, `48`; a newer site may send others, so keep a fallback.
>
> **feedRetainMinutes** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. After a refresh the old photos stop being shown immediately, but their files are kept this long before being deleted — a safety margin for pages already sent to a browser and for CDN caches. 0 deletes them right away. 0 to 10080.
>
> **feedLastRunAt** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set automatically. The schedule paces the next refresh off this.
>
> **feedLastStatus** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Last result.
>
> **feedPhotoCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Photos showing.
>
> **feedLastError** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Why the last refresh failed, when it did. A failed refresh never empties the gallery — the previous photos keep showing.
>
> **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.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **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 `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:photo-feeds:write` (or a master above it: `content:photo-feeds: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) in `config/attract.ts` for longer.

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/photo_feeds_create_photo_feed.spec.ts`, then run your tests:

```ts tests/unit/photo_feeds_create_photo_feed.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import CreatePhotoFeedController from '#controllers/create_photo_feed_controller'

test('photoFeeds.createPhotoFeed', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(CreatePhotoFeedController)
  await controller.handle()

  site.assertCalled('photoFeeds.createPhotoFeed')
})
```

```bash Terminal theme={"dark"}
node ace test
```

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

```ts tests/unit/photo_feeds_create_photo_feed_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('photoFeeds.createPhotoFeed answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'photoFeeds.createPhotoFeed': factories.PhotoFeed({ title: 'Your value' }),
  })

  const photoFeed = await site.photoFeeds().createPhotoFeed({ title: 'Example title', visibility: 'public' })
  assert.containSubset(photoFeed, { title: 'Your value' })
})
```

## Related

> [card] [List a feed’s photos](https://docs.fetchski-attract.com/adonisjs/reference/photo-feeds/list-photo-feed-photos.md)
>
> `site.photoFeeds().listPhotoFeedPhotos()`

> [card] [List photo feeds](https://docs.fetchski-attract.com/adonisjs/reference/photo-feeds/list-photo-feeds.md)
>
> `site.photoFeeds().listPhotoFeeds()`

> [card] [Get a photo feed](https://docs.fetchski-attract.com/adonisjs/reference/photo-feeds/get-photo-feed.md)
>
> `site.photoFeeds().getPhotoFeed()`

> [card] [Replace a photo feed](https://docs.fetchski-attract.com/adonisjs/reference/photo-feeds/replace-photo-feed.md)
>
> `site.photoFeeds().replacePhotoFeed()`

> [card] [Delete a photo feed](https://docs.fetchski-attract.com/adonisjs/reference/photo-feeds/delete-photo-feed.md)
>
> `site.photoFeeds().deletePhotoFeed()`

> [card] [Update a photo feed](https://docs.fetchski-attract.com/adonisjs/reference/photo-feeds/update-photo-feed.md)
>
> `site.photoFeeds().updatePhotoFeed()`

> [card] [POST /photo-feed](https://docs.fetchski-attract.com/api-reference/photo-feeds/create-a-photo-feed.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.