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

X-Ray

Endpoints for retrieving creators posts with labels.

Operations

Retrieve Creators Posts with Labels

Request

Public API Endpoint

Fetch all posts for a specific creators tagged with the specified media category.
Optional year and month parameters can be used to filter posts by date.
Requires an API key for authentication.

Path
idintegerrequired

ID of the creators whose posts are being retrieved.

Query
yearinteger

Year for filtering posts (optional).

monthinteger

Month for filtering posts (optional).

media_categorystringrequired

Category of media for filtering posts (e.g., 'alcoholic_beverages').

Enum"alcoholic_beverages""graphic_violence""religious_content""sexual_content""hate_content""gambling_content""drug_content""cyber_bullying"
curl -i -X GET \
  'https://apidocs.vwd.ai/_mock/apis/creators/{id}/posts?media_category=alcoholic_beverages&month=0&year=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of posts with labels.

Bodyapplication/jsonArray [
platform_namestring

Platform name.

Example: "Instagram"
datestring(date)

Date of the post.

Example: "January 1, 2024"
linkstring

Link to the post.

Example: "https://instagram.com/post/12345"
scorenumber(float)

Normalized score of the post.

Example: 95.5
categoriesArray of strings

Categories associated with the post.

Example: ["alcoholic_beverages"]
]
Response
application/json
[
  {
    "platform_name": "Instagram",
    "date": "January 1, 2024",
    "link": "https://instagram.com/post/12345",
    "score": 95.5,
    "categories": [ … ]
  }
]

Retrieve creators Timeline by Media Category

Request

Public API Endpoint

Fetch a timeline of posts for a given creators based on the specified media category.
The response groups posts by year and month.
Requires an API key for authentication.

Path
idintegerrequired

ID of the creators.

Query
media_categorystringrequired

Media category to filter posts by (e.g., 'politics_content').

Enum"alcoholic_beverages""graphic_violence""religious_content""sexual_content""hate_content""gambling_content""drug_content""cyber_bullying"
curl -i -X GET \
  'https://apidocs.vwd.ai/_mock/apis/creators/{id}/timeline?media_category=alcoholic_beverages' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Timeline of posts grouped by year and month.

Bodyapplication/jsonArray [
yearinteger

Year of the timeline.

Example: 2024
monthsArray of objects

List of months with active status.

]
Response
application/json
[
  {
    "year": 2024,
    "months": [ … ]
  }
]

X-Ray Brands

Endpoints for creators posts and timelines related to brands.

Operations

X-Ray Compliance

Endpoints for creators compliance data.

Operations