Skip to main content
GET
/
products
/
enrich
/
{id}
JavaScript
import HenrySDK from '@henrylabs/sdk';

const client = new HenrySDK({
  apiKey: process.env['HENRY_SDK_API_KEY'], // This is the default and can be omitted
});

const response = await client.products.enrich.retrieveStatus(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.createdAt);
{
  "success": true,
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "message": "Enrichment pending",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

Response

Current status of the enrich request

​
success
boolean
required
​
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)$
​
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
timeout
​
message
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
completedAt
string
​
data
object
​
errorMessage
string