0layers

List brands

List the brands on the authenticated account, newest first. Use this to find a brandId before extracting or generating.

Create a brand from a website

Create a brand from a public business website. This does not start extraction — call start_brand_extraction next. Creating the same website twice creates two brands, so list_brands first if one may already exist.

Start brand extraction

Learn a brand from its website: logo, colours, typography, voice, and business context. Asynchronous — poll get_extraction_status until it reports complete before generating.

Check extraction status

Report how far brand extraction has got. Poll this until it reports complete; generating before then fails.

Generate on-brand content

Start a batch of on-brand social content for a brand. THIS SPENDS CREDITS from the user's balance and cannot be undone — confirm with the user before calling it. Asynchronous; poll list_generations for results. If a call fails, check list_generations before retrying: there is no idempotency key, so a blind retry can start a second paid batch.

List generated content

List completed content for a brand, with download URLs for images. Also the way to reconcile after a failed generate_content call.

Check the credit balance

Report the account's remaining generation credits. Worth checking before generate_content, which spends them.