Index an account by website or social URL

Look up a brand by website URL, or start indexing it if we do not have it yet. Pass a single websiteUrl. Instagram and TikTok profile URLs are accepted and resolved as creators.

This endpoint does not consume credits. An existing brand returns status: "already_exists". A new brand is created and sync is queued, returning status: "indexing" and the new brandId.

Limited to 50 requests per minute per user. This call is free.

Authentication

AuthorizationBearer

An API key from Settings → API, prefixed sg_live_.

Request

This endpoint expects an object.

websiteUrlstringRequired1-2048 characters

Response

The brand id and whether indexing was started.

brandIdstring

statusenum

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

405

Method Not Allowed Error

413

Content Too Large Error

429

Too Many Requests Error

500

Internal Server Error