> ## 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 tag

> Create a new image tag for organizing images

```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 imageTag = await site.media().createImageTag({ title: 'Hero Images' })
```

```json 200 wrap theme={"dark"}
{
  "_id": "clx1234567890abcdef",
  "title": "Hero Images",
  "slug": "hero-images",
  "type": "@apostrophecms/image-tag",
  "archived": false,
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}
```

## In your app

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

**1. Add the controller**

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

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

  async handle() {
    return this.site.media().createImageTag({ title: 'Hero Images' })
  }
}
```

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 CreateImageTagController = () => import('#controllers/create_image_tag_controller')

router.post('/image-tag', [CreateImageTagController])
```

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 /image-tag` and gets back its answer as JSON. Test it, below, calls it.

> [accordion] Required parameters
>
> One object, e.g. `createImageTag({ title })`; leave out the optional fields.
>
> **title** `string` *required*
>
> **Required.** Tag name.

> [accordion] Optional parameters
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **slug** `string | null | undefined`
>
> **Optional.** URL-friendly tag name 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.
>
> **copyOfId** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The `_id` of the piece/page that was copied to create this document (only present if created via `_copyingId`)

> [accordion] Returns
>
> An `ImageTag`. Built-in image tag piece type for organizing images. Read its properties (`imageTag.id`): 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`).
>
> **id** `string`
>
> **Always sent.**
>
> **title** `string`
>
> **Always sent.** Tag name.
>
> **slug** `string`
>
> **Always sent.** URL-friendly tag name.
>
> **type** `string`
>
> **Always sent.**
>
> **createdAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **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.
>
> **copyOfId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The `_id` of the piece/page that was copied to create this document (only present if created via `_copyingId`)
>
> **aposShareKey** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.

> [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`.
>
> **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: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) 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/media_create_image_tag.spec.ts`, then run your tests:

```ts tests/unit/media_create_image_tag.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 CreateImageTagController from '#controllers/create_image_tag_controller'

test('media.createImageTag', async () => {
  const site = fakeAttract()

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

  site.assertCalled('media.createImageTag')
})
```

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

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

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

test('media.createImageTag answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'media.createImageTag': factories.ImageTag({ id: 'Your value' }),
  })

  const imageTag = await site.media().createImageTag({ title: 'Hero Images' })
  assert.containSubset(imageTag, { id: 'Your value' })
})
```

## Related

> [card] [List images](https://docs.fetchski-attract.com/adonisjs/reference/media/list-images.md)
>
> `site.media().listImages()`

> [card] [Create an image](https://docs.fetchski-attract.com/adonisjs/reference/media/create-image.md)
>
> `site.media().createImage()`

> [card] [Archive images](https://docs.fetchski-attract.com/adonisjs/reference/media/archive-images.md)
>
> `site.media().archiveImages()`

> [card] [Crop images to a widget’s aspect ratio](https://docs.fetchski-attract.com/adonisjs/reference/media/autocrop-images.md)
>
> `site.media().autocropImages()`

> [card] [Copy images to another locale](https://docs.fetchski-attract.com/adonisjs/reference/media/localize-images.md)
>
> `site.media().localizeImages()`

> [card] [Publish images](https://docs.fetchski-attract.com/adonisjs/reference/media/publish-images.md)
>
> `site.media().publishImages()`

> [card] [POST /@apostrophecms/image-tag](https://docs.fetchski-attract.com/api-reference/media/create-an-image-tag.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.