Skip to content

Read a brush pack

GET
/brush-packs/{packId}

Returns one of your brush packs and its stamp manifest.

You need to be signed in with a session or API token. This handler returns 404 when you aren’t signed in, when the pack doesn’t exist and when someone else owns it, even though the schema also lists 401. It checks account ownership directly; no permission or administrator override reaches another account’s pack. An invalid UUID can get 400 before the handler runs.

The response includes the complete stamp list, not bitmap bytes. The pack and its stamps are read separately, so a concurrent deletion can leave a returned pack with stamps:[]. Otherwise every stored stamp row is listed, whether there are none, one or many.

Stamps are sorted by creation time with no further tie-breaker. Rows from one import share a transaction timestamp, so their original file order isn’t guaranteed. There’s no pagination or server-side catalogue cache, and this read doesn’t check that the stored images are available.

packId
required
string format: uuid

Pack UUID from an import or a catalogue read. Ownership is checked against the current account, and the same 404 covers a missing pack and another account’s pack. A malformed UUID gets 400 before the operation handler runs.

The owned pack and its complete stamp manifest.

A pack owned by one account, with its complete stamp manifest. These endpoints create packs by importing ABR samples; the manifest doesn’t include bitmap bytes or the original ABR.

object
id
required

Database pack UUID. Every successful import creates a new one, including repeated imports of the same file.

string format: uuid
name
required

Saved display name, taken from the explicit upload field or the filename fallback.

string
source_file

The uploaded file’s basename, when it isn’t empty. It’s display metadata, not a link to a kept ABR file.

string
nullable
created_at
required

When the import’s database transaction started, not when the upload finished. Catalogue reads sort on it, newest first, with no tie-breaker.

string format: date-time
stamps
required

Complete metadata for the stored stamps, or an empty array. Import responses follow decoded sample order; later reads sort by creation time alone, so stamps from the same transaction may not keep that order.

Array<object>

Metadata for one stored stamp. Fetch its PNG from /brush-packs/stamps/{id}. Imports currently use default stroke settings instead of reading Photoshop descriptor dynamics.

object
id
required

Database stamp UUID, stable for as long as this row exists. Reimporting creates a new ID. It isn’t the ABR sample identifier or a content hash.

string format: uuid
label

Optional saved label. Current ABR imports leave it out because descriptor names aren’t imported; the web client shows Stamp instead.

string
nullable
width
required

Decoded mask width in pixels, preserved when the PNG is encoded.

integer
height
required

Decoded mask height in pixels, preserved when the PNG is encoded.

integer
spacing
required

Distance between successive stamps, as a fraction of their effective diameter. Imports set 0.1. The database accepts values above zero up to 10; the schema’s minimum of zero is broader.

number format: double
<= 10
align_to_path
required

Whether the renderer rotates a stamp to follow the stroke. Current imports set false.

boolean
size_jitter

Optional random size variation, from 0 to 1. Current imports leave it out rather than copying Photoshop dynamics.

number format: double
nullable
opacity_jitter

Optional random opacity variation, from 0 to 1. Current imports leave it out rather than copying Photoshop dynamics.

number format: double
nullable
angle_jitter

Optional random angle variation in degrees, from 0 to 360. Current imports leave it out rather than copying Photoshop dynamics.

number format: double
nullable

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed