VwD External API (1.0.0)

External API for accessing VwD creators data.

Download OpenAPI description
Overview
VwD API Support

hello@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

Retrieve an creator's profile

Request

Public API Endpoint

Use this endpoint to retrieve an creator's profile. Only accessible if the API key is valid and the creators belongs to the organization associated with the API key.

Path
idintegerrequired

The ID of the creators to retrieve.

Example: 12345
curl -i -X GET \
  https://api.vwd.ai/api/public/v1/creators/12345/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the creators profile.

Bodyapplication/json
idinteger
Example: 10
namestring
Example: "Influencer 1"
photo_urlstring or null
Example: "https://media.vwd.ai/media/creators-profile-pics/influencer.jpg"
regionstring or null
Example: "europe"
genderstring or null
Example: "female"
is_publicboolean
Example: true
followers_reachinteger or null
Example: 500000
follower_reach_normalisedstring
Example: "500 k"
pronounstring or null
Example: "she/her"
ageinteger or null
Example: 28
social_profilesArray of objects
scoresobject
summarystring or null
Example: "Popular lifestyle influencer based in North America"
avg_comments_per_poststring
Example: "150"
avg_likes_per_poststring
Example: "5.2 k"
avg_views_per_videostring
Example: "12.5 k"
total_compliance_violationsinteger
Example: 0
brandsArray of objects

List of associated brands

Response
application/json
{ "id": 10, "name": "Influencer 1", "photo_url": "https://media.vwd.ai/media/creators-profile-pics/influencer.jpg", "region": "europe", "gender": "female", "is_public": true, "followers_reach": 500000, "follower_reach_normalised": "500 k", "pronoun": "she/her", "age": 28, "social_profiles": [ {} ], "scores": { "property1": {}, "property2": {} }, "summary": "Popular lifestyle influencer based in North America", "avg_comments_per_post": "150", "avg_likes_per_post": "5.2 k", "avg_views_per_video": "12.5 k", "total_compliance_violations": 0, "brands": [ {} ] }

List all creators

Request

Public API Endpoint

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://api.vwd.ai/api/public/v1/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

Public API Endpoint

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

Social media platform name

Enum"instagram""tiktok""youtube""twitter""facebook"
Example: "instagram"
social_profiles[].​profile_urlstring
Example: "https://instagram.com/janedoe"
confirm_duplicateboolean

When set to true, allows adding creators despite them already existing in the organization. Duplicates within the same request are always omitted regardless of this flag.

Default false
Example: false
curl -i -X POST \
  https://api.vwd.ai/api/public/v1/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" } }

Brand Management

Endpoints for brand search and management.

Operations

List Management

Endpoints for managing creator lists.

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