Prompts

Generate prompt suggestions

Changed on

Starts a suggestion run with one of the generators behind the app's Add prompts wizards and answers 202 with the run. website writes suggestions from the scraped website (80% non-brand, 20% brand; up to 100 per project, then ERR_LIMIT_REACHED), keyword from a keyword or the project profile (optionally around a competitor), topic from a topic, reddit from Reddit discussions of a topic or brand, paa from Google People Also Ask (up to 5 keywords, counted against the account's 24-hour lookup allowance), reputational from brand reputation questions, translate from the project's prompts of another locale, search_console from the connected property's top queries of the last 28 days (Growth plan or above, ERR_PLAN_REQUIRED). The suggestions land in the Suggested prompts queue; poll GET /prompt_generations/{id}, then accept the ones you want with POST /suggested_prompts/accept. Nothing is tracked until accepted. The request is validated before the run starts, and refused with ERR_LIMIT_REACHED when the plan has no prompt slot left, ERR_INVALID_PARAM with error.meta.reason pitch_prompts_frozen for a launched pitch project, whose prompts are fixed, or ERR_QUOTA_EXCEEDED after 60 runs in an hour (the per-user prompt suggestion allowance, shared with project setup). Requires a read_write scope API key and, for team members, create access to Prompts.

post/prompt_generations

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • URL
    https://api.llmpulse.ai/api/v1/prompt_generations
  • Auth
    API key in header Authorization

Request body

project_idinteger required
source'website' | 'keyword' | 'topic' | 'reddit' | 'paa' | 'reputational' | 'translate' | 'search_console' required

Which Add prompts generator to run

querystring

keyword: optional keyword or research query. topic and reddit: required topic (reddit: the brand when search_type=brand). paa: one keyword, as an alternative to keywords.

countinteger

keyword and topic: how many suggestions to ask for, capped by the prompt slots left

country_codestring

ISO 3166-1 alpha-2 country of the suggestions (default the project country)

language_codestring

ISO language code of the suggestions (default the project language)

competitor_idinteger

keyword: write the suggestions around this competitor of the project

search_type'topic' | 'brand'

reddit: search discussions of a topic or a brand

keywordsstring[]

paa: up to 5 keywords; each is a People Also Ask lookup counted against the account's 24-hour allowance

source_country_codestring

translate: country of the prompts to translate

source_language_codestring

translate: language of the prompts to translate

min_wordsinteger

search_console: skip queries shorter than this many words

all_countriesboolean

search_console: include queries from every country instead of country_code only

propertystring

search_console: the property id to read queries from (GET /search_console/properties lists them); the primary property when omitted

Response

The run, status processing

idstring uuid required

The run id; poll GET /prompt_generations/{id} with it (kept for 24 hours)

project_idinteger required
sourcestring required
status'processing' | 'completed' | 'failed' required
created_atstring date-time required
finished_atstring date-time nullable required
suggestions_countinteger required
request_idstring required

Changes