API Reference
/
Coming Soon
/
Enable creator monitoring

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

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

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

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"
  }
}

Enable creator monitoring

Request

Coming Soon

Enables monitoring for an existing creator in your organization. Idempotent: calling again when already enabled still returns is_monitored: true. Enforces organization monitoring quotas (caps).

Path
idintegerrequired

Creator ID to enable monitoring for

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

Responses

Monitoring enabled successfully

Bodyapplication/json
is_monitoredboolean
Example: true
Response
application/json
{
  "is_monitored": true
}

List creator lists

Request

Coming Soon

List creator lists for the organization (API key). Supports pagination via page and limit query params.

Query
pageinteger

Page number for pagination.

Example: page=1
limitinteger

Number of results per page.

Example: limit=10
curl -i -X GET \
  'https://api.vwd.ai/api/public/v1/lists/?limit=10&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved lists.

Bodyapplication/json
listsArray of objects
totalinteger

Total number of lists

Example: 10
countinteger

Number of lists in current page

Example: 2
nextstring or null

URL for next page

Example: null
Response
application/json
{
  "lists": [
    { … }
  ],
  "total": 10,
  "count": 2,
  "next": null
}