Briefs

Create an image brief

Save an image brief as a draft — typically the content returned by POST /image-briefs/generate, but any content is accepted. Up to 3 products; index 0 is the hero. Omit name and the brief is named after its headline.

Idempotency-Key is required so a retry doesn't leave you with duplicate drafts. X-Dry-Run: true validates without saving.

post/image-briefs

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/image-briefs
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

product_idsstring[]
template_idstring
accent_colorstring nullable
main_header_backgroundstring nullable
namestring nullable
image_overridesobject

Response

Successful Response

dry_runboolean

Changes

No operation changes recorded.