Skip to main content
GET
Get a suggestion generation
Returns the status of one generation. This is the resource identified by the Location header from Generate prompt suggestions. When it is COMPLETED, read the suggestions with Get 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
required
Generation identifier returned when the generation started.

Response

string
Generation identifier
string
PENDING, RUNNING, COMPLETED or FAILED
string
manual, onboarding, topic or profile
string | null
Topic the generation targeted, when source is topic
integer | null
Number of recommended suggestions, once known
string
ISO 8601 creation time
string | null
ISO 8601 completion time, or null while the generation is in progress

Synthetic request and response

Errors

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