Skip to main content
GET
Get Prompt Suggestions

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

Query Parameters

as_of
string<uuid> | null

Include only scans up to this completed scan id.

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
cursor
string | null
Maximum string length: 4096
segment
string | null
Maximum string length: 200

Response

Successful Response

items
V1PromptSuggestion · object[]
required
limit
integer
required
measurement
KeywordMeasurement · object | null
required
meta
Meta · object
required

Normalized query and newest included scan.

next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required
pool
V1DiscoverPool · object
required
sources
V1DiscoverSources · object
required
state
enum<string>
required
Available options:
ready,
awaiting_first_scan
suggestions
V1PickerSuggestion · object[]
required
total
integer
required
unavailable
V1DiscoverUnavailable · object[]
required