API Reference
/
Brand Management
/
Find brand by name

VwD External API (1.0.0)

External API for accessing VwD creators data.

Download OpenAPI description
index.json
index.yaml
Overview
VwD API Support

support@vwd.ai

License

MIT

Languages
Servers
VwD Production API Server

https://api.vwd.ai/api/public/v1/

Mock server

https://apidocs.vwd.ai/_mock/apis/

Creator Management

Endpoints related to creators information and searches.

Operations

Brand Management

Endpoints for brand search and management.

Operations

Find brand by name

Request

Public API Endpoint

Find brand by name (case-insensitive exact match). Returns an array with 0 or 1 item, each with id and name.

Query
namestring

Case-insensitive brand name to match exactly. If omitted or blank, returns an empty list.

Example: name=NIKE
curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/brands/?name=NIKE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved brands matching the name.

Bodyapplication/jsonArray [
idinteger

Brand ID

Example: 1
namestring

Brand name (stored normalized to lowercase)

Example: "nike"
]
Response
application/json
[
  {
    "id": 1,
    "name": "nike"
  }
]

List Management

Endpoints for managing creator lists.

Operations

Search

Full-text search endpoints powered by Elasticsearch.

Operations

Account & Tokens

Token-budget discovery and scan-catalog endpoints for the prepaid token model that powers creator scans, re-scans, and monitoring.

Prepaid tokens. Billable actions (new scans via POST /creators/, re-scans via POST /creators/{id}/rescan/, monitoring via POST /creators/{id}/monitor/) consume tokens from your organization's API budget. Read the current balance with GET /account/usage/. Token purchasing happens outside the API — contact your account manager to top up.

Scan tiers. A scan tier determines how much creator history is analyzed and the token cost. Initial-scan tiers (scan_1y / scan_2y / scan_full) are used on creator create; re-scan tiers (rescan_lite / rescan_mild / rescan_full) refresh or deepen an existing creator. Costs are admin-configurable — always read GET /scan-catalog/ for live values instead of hardcoding tiers.

Data visibility windows. Historical sub-resources (posts, timeline, brands, compliance) for newly-added creators are scoped to the time range covered by the scan tier purchased. The visibility{} block on GET /creators/{id}/ tells you the exact window and whether a deeper scan is available. Creators added before the token-model launch (2026-05-30) remain unrestricted.

Previewing cost. Append ?dry_run=true on POST /creators/ (single & bulk) or POST /creators/{id}/monitor/ to preview the token cost and outcome without making any change or debiting tokens. Validation still runs.

See the PLG launch changelog post for the full migration guide.

Operations

Content Analysis

Endpoints for retrieving creators posts with labels.

Operations

Brand Mentions

Endpoints for creators posts and timelines related to brands.

Operations

Compliance Monitoring

Endpoints for creators compliance data.

Operations