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/

Creators

Endpoints related to creators information and searches.

Operations

Search and list creators

Request

Public API Endpoint

Use this endpoint to search creators based on various filters, with support for pagination and ordering. This is a POST request and requires an API key for authentication.

Provide filters to narrow down the search results. If no filters are provided, all creators are listed with pagination applied.

Query
limitinteger

Number of results per page.

Example: limit=10
pageinteger

Page number for pagination.

Example: page=1
orderingstring

Ordering of results. Use a minus (-) prefix for descending order.

Enum"created_at""-created_at""followers_reach""-followers_reach"
Example: ordering=-created_at
Bodyapplication/jsonrequired
regionstring

Filter creators by their region.

Example: "europe"
genderstring

Filter creators by gender.

Example: "male"
followers_reachinteger

Minimum follower reach for filtering.

Example: 720000
platformobject

Platform filters (e.g., Instagram, Facebook).

content_alignmentobject

Content alignment filters for various types of content.

brandsArray of strings

Filter by associated brands.

Example: []
creators_display_namestring

Filter by the creator's display name (partial match allowed).

Example: "John"
is_filteredboolean

Whether to apply the filters or not.

Example: true
curl -i -X POST \
  'https://apidocs.vwd.ai/_mock/apis/creators/search?limit=0&ordering=created_at&page=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "region": "europe",
    "gender": "male",
    "followers_reach": 720000,
    "platform": {
      "instagram": true,
      "facebook": false
    },
    "content_alignment": {
      "language_content": 85,
      "sexual_content": 85,
      "violence_content": 86,
      "cyber_bullying_content": 84,
      "drug_content": 84,
      "hate_content": 82,
      "alcohol_content": 83,
      "gambling_content": 82,
      "politics_content": 81,
      "religion_content": 80
    },
    "brands": [],
    "creators_display_name": "John",
    "is_filtered": true
  }'

Responses

A paginated list of creators matching the provided filters.

Bodyapplication/json
nextstring

URL for the next page of results.

Example: "https://api.qa.vwd.ai/api/public/v1/creators/search/?limit=10&ordering=-created_at&page=2"
previousstring

URL for the previous page of results.

Example: null
total_pagesinteger

Total number of pages available.

Example: 15
totalinteger

Total number of creators matching the filters.

Example: 144
creatorsArray of objects

A list of creators matching the filters.

Response
application/json
{
  "next": "https://api.qa.vwd.ai/api/public/v1/creators/search/?limit=10&ordering=-created_at&page=2",
  "previous": null,
  "total_pages": 15,
  "total": 144,
  "creators": [
    { … }
  ]
}

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://apidocs.vwd.ai/_mock/apis/creators/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the creators profile.

Bodyapplication/json
idinteger
Example: 3975
namestring
Example: "BMW"
photo_urlstring
Example: "https://media.qa.vwd.ai/media/creators-profile-pics/bmw.jpg"
regionstring
Example: "india"
genderstring
Example: "non_binary"
followers_reachinteger
Example: 40337817
social_profilesArray of objects
scoresobject
summarystring
Example: "BMW is a non-binary creators based in India, active on Instagram."
Response
application/json
{
  "id": 3975,
  "name": "BMW",
  "photo_url": "https://media.qa.vwd.ai/media/creators-profile-pics/bmw.jpg",
  "region": "india",
  "gender": "non_binary",
  "followers_reach": 40337817,
  "social_profiles": [
    { … }
  ],
  "scores": {
    "property1": { … },
    "property2": { … }
  },
  "summary": "BMW is a non-binary creators based in India, active on Instagram."
}

X-Ray

Endpoints for retrieving creators posts with labels.

Operations

X-Ray Brands

Endpoints for creators posts and timelines related to brands.

Operations

X-Ray Compliance

Endpoints for creators compliance data.

Operations