brands

Draft prompts and competitors from the brand's homepage

Reads the brand's homepage and sitemap and drafts prompts (as many as the workspace's prompt pool has room for, 10 to 25), each with the page on the brand's site that should answer it when one does, and up to six competitors, for a person to review. Nothing is added to the brand: add the prompts that are kept with POST /brands/{brandId}/prompts, passing each one's page, and each competitor with POST /brands/{brandId}/entities.

Returns the stored draft (200, generated: false) when one exists, unless regenerate is true. A new draft (201) takes from a few seconds to about a minute. Three drafts per brand and ten per workspace per rolling day: 429 suggestion_limit, with details.retryAfterSeconds. 503 not_configured when drafting is unavailable; setup works without it.

post/brands/{brandId}/setup-suggestions

Request

  • Base URL: https://shruwd.io/api/v1
  • URL: https://shruwd.io/api/v1/brands/{brandId}/setup-suggestions
  • Auth: HTTP bearer

Request body

regenerateboolean

Replace the stored draft with a new one.

Response

The stored draft; nothing was drafted.

generatedboolean required

False when the stored draft was returned.

Changes

No recorded changes to this operation across all 1 revision of this API.