Skip to main content
GET
Get prompt suggestions
Returns the latest Prompt Studio generation for the workspace. Suggestions come in order: the 20 recommendations first, then the rest of the scored pool. By default the response contains the 20 recommendations. Set limit to read more of the pool, up to 500 suggestions; total gives the size of the whole pool. When no generation exists yet, run is absent and suggestions is an empty array; start one with Generate prompt suggestions. Available on Growth, Agency Growth, Business, Agency Business and Enterprise plans. See Authentication.
string
required
Bearer token for your team.
string
required
Workspace identifier. The workspace must belong to the token’s team.
string
default:"balanced"
balanced, DISCOVERY, CONSIDERATION, PERCEPTION or AUTHORITY.
integer
default:"20"
Maximum number of suggestions returned, recommendations first. An integer from 1 to 500.

Response

object
The generation these suggestions come from. Absent when no generation exists yet. Same fields as Get a suggestion generation.
string
The focus applied to the ordering
integer
Number of suggestions in the whole pool for this focus, whatever the limit
array
The recommendations first, then the rest of the pool, cut at limit.

Synthetic request and response

Errors

Read errors use the flat or nested shapes described in Error codes. On 429, honor Retry-After.