Skip to main content
GET
Search hooks

Authorizations

Authorization
string
header
required

A workspace API key.

Query Parameters

q
string

Optional text to match against the hook or source metadata.

Maximum string length: 200
platform
enum<string>

Optional source platform filter.

Available options:
youtube_shorts,
instagram_reels,
facebook_reels,
tiktok,
twitter,
reddit,
news,
medium,
google_news,
google_web
niche
string

Optional creator niche or topic filter.

Maximum string length: 120
language
string

Optional ISO-style source language filter.

Maximum string length: 20
hookType
enum<string>

Optional structural opening-type filter.

Available options:
question,
tutorial_promise,
pov_setup,
statistic,
statement,
unknown
visualHookType
enum<string>

Optional visual opening-type filter.

Available options:
close_up,
talking_head,
text_overlay,
action,
unknown
evidence
enum<string>
default:all

Evidence quality to include: all, observed video evidence, or metadata suggestions. Defaults to all.

Available options:
all,
observed,
metadata
limit
integer
default:20

Maximum matching hooks to return, from 1 through 100. Defaults to 20.

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based page offset into the bounded sample. Defaults to 0.

Required range: 0 <= x <= 700

Response

Success.

success
boolean
required
items
object[]
required
totalInSample
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
hasMore
boolean
required
nextOffset
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
coverage
object
required
stats
object[]
required
{key}
any