Library fields

Library fields let your team keep its own details on every file: a SKU, a product name, an angle, a status. Anyone in the workspace can read them. Owners and editors make the fields and fill them in.

Make the fields

1. Open Settings → Library fields. It’s under your workspace’s pages.
2. Choose New field, give it a Name and pick its Kind: Text, Long text, Number, Date, Pick one, Pick several, Yes or no or Link.
3. For Pick one and Pick several, write the Choices, one on each line.
4. Choose Make field.

A field’s kind can’t change once it’s made. You can rename it, and change its choices. Taking a choice away clears it from the files that have it. A workspace can have up to 50 fields.

To start quickly, choose Add next to Ecommerce fields. It adds SKU, Product name, Variant, Angle, Status and Channels, and skips any you already have.

To remove a field, choose Edit on its row, then Delete field. It comes off every file, with whatever was filled in, and that can’t be undone.

Fill them in

• One file. Open the file, and find Fields under Details, below Tags. Words save when you press Enter or leave the box, and Esc puts back what was there. Choices are picked from a menu.
• Many files. Select them, then choose Edit fields in the bar. Each field shows what the files share, or Mixed where they differ. Only the fields you change are saved, so every file keeps the rest. Choose Clear to empty a field, or Undo to take your change back, then Save.

If a workspace has no fields yet, Details points owners and editors to Library fields. People who can only comment see the fields that are filled in.

Fill them in from a spreadsheet

In the Library, open ⋯ beside the title (on a phone, the ⋯ at the top right) and choose Export fields. You get a CSV with a row for every file: id, file_name, folder, then a column for each field under its key. Several picks are written with ; between them.

Edit it in any spreadsheet, then choose Import fields and pick the file. Shotz reads it and shows what it would do before anything changes: each row’s file, every value going from what to what, and any problems. Choose the Change button, which says how many files, to save the rows that came out clean; rows with problems are left out.

• A sheet you made yourself works too, as long as it has an id or a file_name column. When two files share a name, add folder or id.
• An empty cell leaves that value as it is. Write (clear) to empty one.
• A choice must be one of the field’s choices, in any case. Yes or no takes yes, no, true or false.
• Columns that aren’t a field’s key are listed as not read, and nothing is stored from them.
• One import reads up to 2,000 rows. Only editors and owners can import.

Fill them in from file names

If your files are named in a pattern, like ABC-123_front.jpg, Shotz can read their fields as they upload. In Settings, Library fields, choose Set up on Read from file names and type a pattern such as {sku}_{angle}. A field’s key goes in braces; everything else is matched as it is. The extension is ignored. The setting shows what an example name would give, such as SKU ABC-123 and Angle Front.

A value that doesn’t fit its field, like an angle that isn’t one of its choices, is skipped and the rest still count. Nothing already filled in on a file is changed. Choose Turn off in the same dialog to stop.

Find files by them

Search matches what’s in a field, anywhere in the value: “ab-12” finds a file whose SKU is AB-1234. In Filter, each field has its own row. A choice field lists its choices and a last one such as No Angle, a Yes or no field offers Yes, No and Not set, and the rest offer choices such as Has SKU and No SKU. See Find files in your Library.

Carry them onto what you make

Turn on Carry over in a field’s Edit dialog and its value follows a file into what’s made from it: a cutout, an upscale, a changed clip, or a take started from one photo. The new file gets the value unless it already has its own. A field that carries shows Carries over in the list. SKU, Product name and Variant carry by default in the ecommerce set; new fields don’t.

A design started from a Library photo keeps them too, through crops and cutouts. Choosing Mock it up or Make a video in Studio saves the page to your Library with them.

Name exports from them

In Studio, Export has File names once your workspace has fields. Type a pattern like {sku}_{angle}_{size}, or tap a field’s chip to add it. Each page is named from its photo’s fields, and the line under the box shows what the open page would be called.

• A field is written as its name in lower case with underscores, like {sku} or {product_name}.
• {size} is the picture’s pixels, {shape} its shape, {page} its number and {name} the design’s name.
• Use at least one field. A pattern with a name that doesn’t exist shows what’s wrong, and the export keeps the design’s names.
• A page with none of the pattern’s fields filled in keeps the design’s name. A field left empty drops its separator.
• In a zip, a name used twice gets _2, _3 and so on.

The pattern is remembered in this browser.

Changes to fields are recorded in the audit log.

Ask the Agent

The Agent knows your workspace’s fields. Ask it to find files by them (“the approved shots of SKU 4410”), or to fill them in on the files you have picked or name: “tag these with SKU 4410 and mark them approved”. It changes only the fields you mention, checks each value the same way the Library does, and it’s free. Commenters can ask about fields but not change them.

Use them from the API

GET /api/v1/media gives each file’s fields and takes field.<key>=<value> to list files by them, and POST /api/v1/generations takes fields to set on everything it makes. See List models and your Library and Generate with the API.