API Reference
/
Creator Management
/
Deepen or refresh a creator

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

Enable creator monitoring

Request

Public API Endpoint

Enables monitoring for an existing creator in your organization. Idempotent: calling again when already enabled still returns is_monitored: true. Charges the per-cycle monitoring cost from GET /scan-catalog/ → monitoring.token_cost on first enable.

Append ?dry_run=true to preview cost without enabling monitoring.

Path
idintegerrequired

Creator ID to enable monitoring for.

Example: 123
Query
dry_runboolean

If true, return a cost preview (200 with DryRunResponse) instead of enabling monitoring. Accepts true/1 (case-insensitive). Zero side effects. The 404 check runs before dry-run.

Default false
curl -i -X POST \
  'https://api.vwd.ai/api/public/v1/creators/123/monitor/?dry_run=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Monitoring enabled (idempotent), or dry-run preview returned. The live shape is {is_monitored: true}; the dry-run shape is DryRunResponse.

Bodyapplication/json
One of:
is_monitoredbooleanrequired
Example: true
Response
application/json
{
  "is_monitored": true
}

Deepen or refresh a creator

Request

Public API Endpoint

Trigger a re-scan of an existing creator at a specified tier. Tokens are debited on success. Use GET /scan-catalog/ for valid scan_type slugs and current costs. Re-scan slugs use the rescan_* namespace — do not send a scan_* initial-tier slug here. No ?dry_run=true support on this endpoint.

Path
idintegerrequired

Numeric identifier of the creator.

Example: 84213
Bodyapplication/jsonrequired
scan_typestringrequired

Re-scan tier slug. Must be a rescan_* value from GET /scan-catalog/ → rescans[].

Example: "rescan_full"
curl -i -X POST \
  https://api.vwd.ai/api/public/v1/creators/84213/rescan/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "scan_type": "rescan_full"
  }'

Responses

Re-scan triggered; tokens debited.

Bodyapplication/json
successboolean
Example: true
influencer_idinteger
Example: 84213
scan_typestring
Example: "rescan_full"
tokens_debitedinteger

Tokens actually charged — equals the tier's token_cost, or a smaller amount when a recent prior scan discount applies.

Example: 3
Response
application/json
{
  "success": true,
  "influencer_id": 84213,
  "scan_type": "rescan_full",
  "tokens_debited": 3
}

Brand Management

Endpoints for brand search and management.

Operations

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