Skip to main content
POST
/
products
/
enrich
Enrich Products
curl --request POST \
  --url https://api.henrylabs.ai/v0/products/enrich \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "region": "us"
}
'
{
  "success": true,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "createdAt": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-user-id
string

Optional end-user identifier for tracking purposes

Query Parameters

​
skipCache
boolean

If true, bypasses the cache and forces a fresh scrape

Body

application/json
​
url
string<uri>
required
​
region
enum<string>
default:us
Available options:
ad,
ae,
af,
ag,
ai,
al,
am,
ao,
ar,
at,
au,
aw,
az,
ba,
bb,
bd,
be,
bf,
bg,
bh,
bj,
bl,
bm,
bn,
bo,
br,
bs,
bt,
bw,
by,
bz,
ca,
cd,
cg,
ch,
ci,
cl,
cm,
cn,
co,
cr,
cv,
cy,
cz,
de,
dj,
dk,
dm,
do,
dz,
ec,
ee,
eg,
es,
et,
fi,
fj,
fk,
fr,
ga,
gb,
gd,
ge,
gf,
gg,
gh,
gi,
gl,
gm,
gn,
gp,
gr,
gt,
gu,
gw,
gy,
hk,
hn,
hr,
ht,
hu,
id,
ie,
il,
im,
in,
is,
it,
je,
jm,
jo,
jp,
ke,
kg,
kh,
kn,
kr,
kw,
ky,
kz,
la,
lb,
lc,
lk,
lr,
ls,
lt,
lu,
lv,
ly,
ma,
mc,
md,
me,
mg,
mh,
mk,
ml,
mm,
mn,
mo,
mq,
mr,
ms,
mt,
mu,
mv,
mw,
mx,
my,
mz,
na,
ne,
ng,
ni,
nl,
no,
np,
nz,
om,
pa,
pe,
pf,
pg,
ph,
pk,
pl,
pr,
pt,
py,
qa,
ro,
rs,
ru,
rw,
sa,
sc,
se,
sg,
si,
sk,
sl,
sm,
sn,
so,
sr,
ss,
sv,
sx,
sz,
tc,
td,
tg,
th,
tj,
tl,
tn,
tr,
tt,
tw,
tz,
ua,
ug,
us,
uy,
uz,
vc,
ve,
vg,
vi,
vn,
xk,
ye,
za,
zm,
zw

Response

Request accepted and processing started

​
success
boolean
required
​
status
enum<string>
required
Available options:
pending,
processing
​
requestId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
message
string
required
​
createdAt
string
required