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

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Create Catalog Image

> Uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing [CatalogObject](entity:CatalogObject) instance.

`square.createCatalogImage` uploads an image file to be represented by a [CatalogImage](entity:CatalogImage) object that can be linked to an existing [CatalogObject](entity:CatalogObject) instance.

## Example

```ts automations/square-create-catalog-image.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Create Square Catalog Image", () => {
  onDashboardRun({ title: "Create Square Catalog Image" })

  square.createCatalogImage({
    imageFile: new File(["image bytes"], "catalog.png", {
      type: "image/png",
    }),
    request: {
      idempotencyKey: crypto.randomUUID(),
      image: {
        id: "#catalog-image",
        imageData: {},
        type: "IMAGE",
      },
    },
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `ITEMS_WRITE`.

| Field       | Type                                         | Required | Default | Description                       |
| ----------- | -------------------------------------------- | -------- | ------- | --------------------------------- |
| `request`   | `Square.CreateCatalogImageRequest`           | No       | —       | Square `request` request field.   |
| `imageFile` | `File \| fs.ReadStream \| Blob \| undefined` | No       | —       | Square `imageFile` request field. |

Use the official [CreateCatalogImage reference](https://developer.squareup.com/reference/square/catalog-api/create-catalog-image) for provider field semantics and limits.

## Output

Returns the official `Square.CreateCatalogImageResponse` response as a codec-safe object. Square integer money amounts remain `bigint` values.