API Reference
/
Coming Soon

VwD External API (1.0.0)

External API for accessing VwD creators data.

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

hello@vwd.ai

License

MIT

Languages
Servers
Mock server

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

VwD Production API Server

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

Creator Management

Endpoints related to creators information and searches.

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

Coming Soon

Upcoming endpoints that will be available in future releases.

Operations

Find brand by name

Request

Coming Soon

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://apidocs.vwd.ai/_mock/apis/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 all creators

Request

Coming Soon

List creators for the authenticated organization with pagination. Response items include associated brands with IDs.

Query
pageinteger

Page number for pagination.

Example: page=1
limitinteger

Number of results per page.

Example: limit=10
include_child_scoresboolean
  • false (default): return parent category scores only (top-level categories)
  • true: return both top-level parent categories and child/leaf tags (zero-filled)
Default false
curl -i -X GET \
  'https://apidocs.vwd.ai/_mock/apis/creators/?include_child_scores=false&limit=10&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved creators list.

Bodyapplication/json
creatorsArray of objects(CreatorWithBrands)
totalinteger

Total number of creators

Example: 100
countinteger

Number of creators in current page

Example: 10
nextstring or null

URL for next page

Example: "https://api.vwd.ai/api/public/v1/creators/?page=2&limit=10"
Response
application/json
{
  "creators": [
    { … }
  ],
  "total": 100,
  "count": 10,
  "next": "https://api.vwd.ai/api/public/v1/creators/?page=2&limit=10"
}

Add creators

Request

Coming Soon

Add creators either one at a time (single JSON object) or in bulk (object with items array). Enforces organization quotas (creation caps); supports partial success in bulk. Detects duplicates and optionally requires confirmation.

Bodyapplication/jsonrequired
One of:
namestringrequired
Example: "Jane Doe"
social_profilesArray of objectsnon-emptyrequired
social_profiles[].​platformstring
Example: "instagram"
social_profiles[].​profile_urlstring
Example: "https://instagram.com/janedoe"
confirm_duplicateboolean
Default false
Example: false
curl -i -X POST \
  https://apidocs.vwd.ai/_mock/apis/creators/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Jane Doe",
    "social_profiles": [
      {
        "platform": "instagram",
        "profile_url": "https://instagram.com/janedoe"
      }
    ],
    "confirm_duplicate": false
  }'

Responses

Bulk creators request processed (partial success allowed)

Bodyapplication/json
resultsArray of objects
summaryobject
quotaobject
Response
application/json
{
  "results": [
    { … }
  ],
  "summary": {
    "requested": 2,
    "valid": 2,
    "created": 1,
    "failed": 1
  },
  "quota": {
    "limit": 1000,
    "used": 500,
    "remaining": 499,
    "allowed_count": 1,
    "reason_code": "PARTIAL_ALLOWED"
  }
}