Loops logo
API docs by Redocly

Loops (1.0.0)

Download OpenAPI specification:

License: AGPL-3.0

The Loops API

Account

account.getSuggestedAccounts

query Parameters
limit
integer [ 3 .. 20 ]

Responses

Response samples

Content type
application/json
[
  • null
]

account.hideSuggestion

Request Body schema: application/json
required
profile_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "profile_id": 0
}

Response samples

Content type
application/json
{
  • "message": "You have reached the limit"
}

account.unhideSuggestion

Request Body schema: application/json
required
profile_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "profile_id": 0
}

Response samples

Content type
application/json
{
  • "message": "Suggestion unhidden"
}

account.selfAccountInfo_0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

account.selfAccountInfo_0

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

account.getAccountInfo

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

account.getRelationshipState

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • null
]

account.accountBlock

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "username": "string",
  • "is_owner": true,
  • "local": true,
  • "bio": "string",
  • "post_count": 0,
  • "follower_count": 0,
  • "following_count": 0,
  • "url": "string",
  • "is_blocking": true,
  • "links": [
    ],
  • "created_at": "string"
}

account.accountUnblock

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "avatar": "string",
  • "username": "string",
  • "is_owner": true,
  • "local": true,
  • "bio": "string",
  • "post_count": 0,
  • "follower_count": 0,
  • "following_count": 0,
  • "url": "string",
  • "is_blocking": true,
  • "links": [
    ],
  • "created_at": "string"
}

account.accountFollowers

path Parameters
id
required
string
query Parameters
search
string or null [ 2 .. 50 ] characters
cursor
string or null

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

account.accountFollowing

path Parameters
id
required
string
query Parameters
search
string or null [ 2 .. 50 ] characters
cursor
string or null

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

account.accountFriends

path Parameters
id
required
string
query Parameters
search
string or null [ 2 .. 50 ] characters
cursor
string or null

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

account.accountSuggestedFollows

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

account.follow

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • null
]

account.unfollow

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • null
]

account.undoFollowRequest

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • null
]

account.accountVideoLikes

query Parameters
cursor
string <= 2000 characters
limit
integer [ 1 .. 20 ]

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "links": {
    },
  • "meta": {
    }
}

account.getSystemNotification

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

account.notifications

query Parameters
type
string
Enum: "all" "activity" "system" "followers"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

account.notificationUnreadCount

Responses

Response samples

Content type
application/json
[
  • null
]

account.markAllNotificationsAsRead

Request Body schema: application/json
type
string
Enum: "all" "activity" "system" "followers"

Responses

Request samples

Content type
application/json
{
  • "type": "all"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

account.markNotificationAsRead

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Auth

auth.registerApp

Request Body schema: application/json
required
client_name
required
string
redirect_uris
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "client_name": "string",
  • "redirect_uris": [
    ]
}

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_name": "string",
  • "client_secret": "string",
  • "redirect_uris": "string",
  • "vapid_key": null
}

auth.verifyTwoFactor

Request Body schema: application/json
required
otp_code
required
integer

Responses

Request samples

Content type
application/json
{
  • "otp_code": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "Invalid session.",
  • "force_relogin": true
}

Duet

Store a newly created resource in storage

Request Body schema: multipart/form-data
required
video
required
string <binary> <application/octet-stream>
duet_id
required
integer
duet_layout
required
string
Enum: "side-by-side" "vertical"
description
string or null <= 200 characters
comment_state
string
Enum: "0" "4"
can_download
boolean or null
can_comment
boolean or null
can_duet
boolean or null
can_stitch
boolean or null
is_sensitive
boolean or null
alt_text
string or null <= 2000 characters
contains_ai
boolean or null
contains_ad
boolean or null
lang
string
Enum: "af" "sq" "am" "ar" "hy" "az" "eu" "be" "bn" "bs" "bg" "my" "ca" "zh" "zh-TW" "hr" "cs" "da" "nl" "en" "et" "fi" "fr" "ka" "de" "el" "ha" "he" "hi" "hu" "is" "id" "ga" "it" "ja" "kn" "kk" "km" "ko" "lv" "lt" "ms" "ml" "mr" "mn" "ne" "no" "fa" "pl" "pt" "pa" "ro" "ru" "sr" "sk" "sl" "so" "es" "sw" "sv" "ta" "te" "th" "tr" "uk" "ur" "uz" "vi" "cy"

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

EmailChange

emailChange.getEmailSettings

Responses

Response samples

Content type
application/json
[
  • null
]

emailChange.changeEmail

Request Body schema: application/json
required
email
required
string <email> <= 255 characters
password
required
string non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

emailChange.cancelEmailChange

Responses

Response samples

Content type
application/json
{
  • "message": "Email change cancelled successfully."
}

emailChange.verifyEmailChange

Request Body schema: application/json
required
user_id
required
integer [ 1 .. 9999999999 ]
token
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": 1,
  • "token": "string"
}

Response samples

Content type
application/json
[
  • null
]

emailChange.resendEmailChange

Request Body schema: application/json
required
user_id
required
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "user_id": 1
}

Response samples

Content type
application/json
{
  • "message": "Verification email resent successfully."
}

Explore

explore.getTrendingTags

Responses

Response samples

Content type
application/json
[
  • null
]

explore.getTagFeed

path Parameters
id
required
string
query Parameters
cursor
string <= 2000 characters
limit
integer [ 1 .. 20 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Feed

feed.getForYouFeed_0

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

feed.selfAccountFeed

query Parameters
sort
string
Enum: "Latest" "Popular" "Oldest"
limit
integer [ 1 .. 20 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

feed.getAccountFeedWithCursor

path Parameters
profileId
required
string
query Parameters
id
required
integer >= 1
limit
integer [ 1 .. 20 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

feed.getForYouFeed_0

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

feed.getFollowingFeed

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

ForYouFeed

forYouFeed.index

query Parameters
cursor
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

forYouFeed.recordImpression

Request Body schema: application/json
required
video_id
required
integer
watch_duration
required
integer >= 0
completed
boolean

Responses

Request samples

Content type
application/json
{
  • "video_id": 0,
  • "watch_duration": 0,
  • "completed": true
}

Response samples

Content type
application/json
{
  • "success": true
}

forYouFeed.recordFeedback

Request Body schema: application/json
required
video_id
required
integer
feedback_type
required
string
Enum: "like" "dislike" "not_interested" "hide_creator"

Responses

Request samples

Content type
application/json
{
  • "video_id": 0,
  • "feedback_type": "like"
}

Response samples

Content type
application/json
{
  • "success": true
}

forYouFeed.removeFeedback

path Parameters
videoId
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Playlist

playlists.index

query Parameters
search
string
sort_field
string
Default: "created_at"
sort_direction
string
Default: "desc"
limit
string
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

playlists.store

Request Body schema: application/json
required
name
required
string <= 30 characters
description
string or null <= 1000 characters
visibility
required
string
Enum: "public" "unlisted" "private" "followers"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "public"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

playlists.show

path Parameters
playlist
required
integer

The playlist ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

playlists.update

path Parameters
playlist
required
integer

The playlist ID

Request Body schema: application/json
name
string <= 30 characters
description
string or null <= 1000 characters
visibility
string
Enum: "public" "unlisted" "private" "followers"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "public"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

playlists.destroy

path Parameters
playlist
required
integer

The playlist ID

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

playlist.videos

path Parameters
playlist
required
integer

The playlist ID

query Parameters
limit
integer [ 1 .. 10 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

playlist.addVideo

path Parameters
playlist
required
integer

The playlist ID

Request Body schema: application/json
required
video_id
required
integer
position
integer or null >= 0

Responses

Request samples

Content type
application/json
{
  • "video_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "message": "Video added to playlist"
}

playlist.removeVideo

path Parameters
playlist
required
integer

The playlist ID

video
required
integer

The video ID

Responses

Response samples

Content type
application/json
{
  • "message": "Video removed from playlist"
}

playlist.reorder

path Parameters
playlist
required
integer

The playlist ID

Request Body schema: application/json
required
video_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "video_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Playlist reordered"
}

Report

report.store

Request Body schema: application/json
required
type
required
string
Enum: "video" "profile" "comment" "reply" "hashtag"
id
required
string
key
required
integer [ 1010 .. 1026 ]
comment
string or null [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "type": "video",
  • "id": "string",
  • "key": 1010,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

Search

search.search

query Parameters
query
required
string [ 1 .. 100 ] characters
type
string
Enum: "top" "all" "videos" "users" "hashtags"
limit
integer [ 1 .. 20 ]
cursor
string <= 2000 characters

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "links": {
    },
  • "meta": {
    }
}

search.getUsers

Request Body schema: application/json
required
q
required
string [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "q": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Settings

settings.getPrivacy

Responses

Response samples

Content type
application/json
[
  • null
]

settings.updatePrivacy

Request Body schema: application/json
required
discoverable
required
boolean

Responses

Request samples

Content type
application/json
{
  • "discoverable": true
}

Response samples

Content type
application/json
[
  • null
]

settings.checkBirthdate

Responses

Response samples

Content type
application/json
[
  • null
]

settings.setBirthdate

Request Body schema: application/json
required
birth_date
required
string

Responses

Request samples

Content type
application/json
{
  • "birth_date": "string"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

settings.storeBio

Request Body schema: application/json
name
string or null [ 0 .. 30 ] characters
bio
string or null [ 0 .. 80 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "bio": "string"
}

Response samples

Content type
application/json
[
  • null
]

settings.updateAvatar

Request Body schema: multipart/form-data
required
avatar
required
string <binary> <application/octet-stream> [ 1 .. 2048 ] characters

Responses

Response samples

Content type
application/json
[
  • null
]

settings.deleteAvatar

Responses

Response samples

Content type
application/json
[
  • null
]

settings.securityConfig

Responses

Response samples

Content type
application/json
[
  • null
]

settings.updatePassword

Request Body schema: application/json
required
current_password
required
string
password
required
string [ 8 .. 72 ] characters
password_confirmation
required
string [ 8 .. 72 ] characters

Responses

Request samples

Content type
application/json
{
  • "current_password": "string",
  • "password": "stringst",
  • "password_confirmation": "stringst"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

settings.disableTwoFactor

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

settings.setupTwoFactor

Responses

Response samples

Content type
application/json
[
  • null
]

settings.confirmTwoFactor

Request Body schema: application/json
required
code
required
integer

Responses

Request samples

Content type
application/json
{
  • "code": 0
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

settings.totalBlockedAccounts

Responses

Response samples

Content type
application/json
[
  • null
]

settings.blockedAccounts

query Parameters
q
string [ 1 .. 50 ] characters

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

settings.blockedAccountSearch

Request Body schema: application/json
required
q
required
string [ 1 .. 80 ] characters

Responses

Request samples

Content type
application/json
{
  • "q": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

settings.confirmDisableAccount

Request Body schema: application/json
required
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

settings.confirmDeleteAccount

Request Body schema: application/json
required
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

Studio

studio.getPosts

query Parameters
search
string or null [ 2 .. 30 ] characters
limit
integer [ 1 .. 10 ]
sort_field
string
Value: "created_at"
sort_direction
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

studio.getAvailableVideosForPlaylists

query Parameters
search
string or null [ 2 .. 30 ] characters
limit
integer [ 1 .. 10 ]
sort_field
string
Value: "created_at"
sort_direction
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

UserPreferences

userPreferences.show

Responses

Response samples

Content type
application/json
[
  • null
]

userPreferences.update

Request Body schema: application/json
autoplay_videos
boolean
loop_videos
boolean
default_feed
string
Enum: "local" "following" "forYou"
hide_for_you_feed
boolean
mute_on_open
boolean
auto_expand_cw
boolean
appearance
string
Enum: "light" "dark" "system"

Responses

Request samples

Content type
application/json
{
  • "autoplay_videos": true,
  • "loop_videos": true,
  • "default_feed": "local",
  • "hide_for_you_feed": true,
  • "mute_on_open": true,
  • "auto_expand_cw": true,
  • "appearance": "light"
}

Response samples

Content type
application/json
[
  • null
]

UserRegisterVerify

userRegisterVerify.sendEmailVerification

Request Body schema: application/json
required
email
required
string <email>
captcha_type
required
string
Enum: "turnstile" "hcaptcha"
captcha_token
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

userRegisterVerify.resendEmailVerification

Request Body schema: application/json
required
email
required
string <email>

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

userRegisterVerify.verifyEmailVerification

Request Body schema: application/json
required
email
required
string <email>
code
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

userRegisterVerify.claimUsername

Request Body schema: application/json
required
username
required
string [ 2 .. 24 ] characters
password
required
string >= 8 characters
password_confirmation
required
string
birth_date
required
string <date-time>
password_confirmation_confirmation
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "stringst",
  • "password_confirmation": "string",
  • "birth_date": "2019-08-24T14:15:22Z",
  • "password_confirmation_confirmation": "string"
}

Response samples

Content type
application/json
[ ]

userRegisterVerify.verifyAge

Request Body schema: application/json
required
birthdate
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "birthdate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Video

Store a newly created resource in storage

Request Body schema: multipart/form-data
required
video
required
string <binary> <application/octet-stream>
description
string or null <= 200 characters
comment_state
string
Enum: "0" "4"
can_download
boolean or null
can_comment
boolean or null
can_duet
boolean or null
can_stitch
boolean or null
is_sensitive
boolean or null
alt_text
string or null <= 2000 characters
contains_ai
boolean or null
contains_ad
boolean or null
lang
string
Enum: "af" "sq" "am" "ar" "hy" "az" "eu" "be" "bn" "bs" "bg" "my" "ca" "zh" "zh-TW" "hr" "cs" "da" "nl" "en" "et" "fi" "fr" "ka" "de" "el" "ha" "he" "hi" "hu" "is" "id" "ga" "it" "ja" "kn" "kk" "km" "ko" "lv" "lt" "ms" "ml" "mr" "mn" "ne" "no" "fa" "pl" "pt" "pa" "ro" "ru" "sr" "sk" "sl" "so" "es" "sw" "sv" "ta" "te" "th" "tr" "uk" "ur" "uz" "vi" "cy"

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

video.storeCommentLike

path Parameters
vid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "v_id": "string",
  • "account": {
    },
  • "caption": "This comment was deleted by the user",
  • "likes": 0,
  • "replies": 0,
  • "children": [ ],
  • "tags": [ ],
  • "mentions": [ ],
  • "is_edited": true,
  • "liked": true,
  • "url": null,
  • "is_owner": true,
  • "tombstone": true,
  • "created_at": "string"
}

video.storeCommentReplyLike

path Parameters
vid
required
string
pid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "p_id": null,
  • "v_id": "string",
  • "account": {
    },
  • "caption": "This comment was deleted by the user",
  • "likes": 0,
  • "liked": true,
  • "url": null,
  • "tags": [ ],
  • "mentions": [ ],
  • "is_edited": true,
  • "tombstone": true,
  • "is_owner": true,
  • "created_at": "string"
}

video.storeCommentReplyUnlike

path Parameters
vid
required
string
pid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

video.storeCommentUnlike

path Parameters
vid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

video.deleteComment

path Parameters
vid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

video.deleteCommentReply

path Parameters
vid
required
string
pid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

video.storeCommentReplyUpdate

path Parameters
vid
required
string
Request Body schema: application/json
required
id
required
string
comment
required
string [ 1 .. 500 ] characters
parent_id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "comment": "string",
  • "parent_id": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

video.storeCommentUpdate

path Parameters
vid
required
string
Request Body schema: application/json
required
id
required
string
comment
required
string [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

video.storeComment

path Parameters
vid
required
string
Request Body schema: application/json
required
parent_id
integer
comment
required
string [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "parent_id": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

video.showCommentsHistory

path Parameters
vid
required
string
cid
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

video.showCommentReplyHistory

path Parameters
vid
required
string
cid
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Update the specified resource in storage

path Parameters
id
required
string
Request Body schema: application/json
caption
string or null <= 200 characters
can_download
boolean or null
can_comment
boolean or null
can_duet
boolean or null
can_stitch
boolean or null
is_pinned
boolean or null
alt_text
string or null <= 2000 characters
is_sensitive
boolean or null
contains_ai
boolean or null
contains_ad
boolean or null
lang
string or null
Enum: "af" "sq" "am" "ar" "hy" "az" "eu" "be" "bn" "bs" "bg" "my" "ca" "zh" "zh-TW" "hr" "cs" "da" "nl" "en" "et" "fi" "fr" "ka" "de" "el" "ha" "he" "hi" "hu" "is" "id" "ga" "it" "ja" "kn" "kk" "km" "ko" "lv" "lt" "ms" "ml" "mr" "mn" "ne" "no" "fa" "pl" "pt" "pa" "ro" "ru" "sr" "sk" "sl" "so" "es" "sw" "sv" "ta" "te" "th" "tr" "uk" "ur" "uz" "vi" "cy"

Responses

Request samples

Content type
application/json
{
  • "caption": "string",
  • "can_download": true,
  • "can_comment": true,
  • "can_duet": true,
  • "can_stitch": true,
  • "is_pinned": true,
  • "alt_text": "string",
  • "is_sensitive": true,
  • "contains_ai": true,
  • "contains_ad": true,
  • "lang": "af"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": {
    },
  • "caption": "string",
  • "url": "string",
  • "is_owner": "string",
  • "is_sensitive": true,
  • "media": {
    },
  • "pinned": true,
  • "likes": 0,
  • "shares": 0,
  • "comments": 0,
  • "bookmarks": 0,
  • "has_liked": "string",
  • "has_bookmarked": true,
  • "is_edited": true,
  • "lang": "string",
  • "tags": [
    ],
  • "mentions": [
    ],
  • "permissions": {
    },
  • "audio": {
    },
  • "meta": {
    },
  • "created_at": "string"
}

Remove the specified resource from db/storage

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "error": {
    }
}

Like a video

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": {
    },
  • "caption": "string",
  • "url": "string",
  • "is_owner": "string",
  • "is_sensitive": true,
  • "media": {
    },
  • "pinned": true,
  • "likes": "string",
  • "shares": 0,
  • "comments": 0,
  • "bookmarks": 0,
  • "has_liked": true,
  • "has_bookmarked": true,
  • "is_edited": true,
  • "lang": "string",
  • "tags": [
    ],
  • "mentions": [
    ],
  • "permissions": {
    },
  • "audio": {
    },
  • "meta": {
    },
  • "created_at": "string"
}

Unlike a video

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": {
    },
  • "caption": "string",
  • "url": "string",
  • "is_owner": "string",
  • "is_sensitive": true,
  • "media": {
    },
  • "pinned": true,
  • "likes": 0,
  • "shares": 0,
  • "comments": 0,
  • "bookmarks": 0,
  • "has_liked": "string",
  • "has_bookmarked": true,
  • "is_edited": true,
  • "lang": "string",
  • "tags": [
    ],
  • "mentions": [
    ],
  • "permissions": {
    },
  • "audio": {
    },
  • "meta": {
    },
  • "created_at": "string"
}

video.bookmark

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": {
    },
  • "caption": "string",
  • "url": "string",
  • "is_owner": "string",
  • "is_sensitive": true,
  • "media": {
    },
  • "pinned": true,
  • "likes": 0,
  • "shares": 0,
  • "comments": 0,
  • "bookmarks": 0,
  • "has_liked": "string",
  • "has_bookmarked": true,
  • "is_edited": true,
  • "lang": "string",
  • "tags": [
    ],
  • "mentions": [
    ],
  • "permissions": {
    },
  • "audio": {
    },
  • "meta": {
    },
  • "created_at": "string"
}

video.unbookmark

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "account": {
    },
  • "caption": "string",
  • "url": "string",
  • "is_owner": "string",
  • "is_sensitive": true,
  • "media": {
    },
  • "pinned": true,
  • "likes": 0,
  • "shares": 0,
  • "comments": 0,
  • "bookmarks": 0,
  • "has_liked": "string",
  • "has_bookmarked": true,
  • "is_edited": true,
  • "lang": "string",
  • "tags": [
    ],
  • "mentions": [
    ],
  • "permissions": {
    },
  • "audio": {
    },
  • "meta": {
    },
  • "created_at": "string"
}

video.showVideoHistory

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

video.showVideoLikes

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

video.showVideoShares

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

video.showAutocompleteTags

query Parameters
q
required
string [ 2 .. 60 ] characters
limit
integer [ 1 .. 10 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

video.showAutocompleteAccounts

query Parameters
q
required
string [ 2 .. 90 ] characters
limit
integer [ 1 .. 10 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

VideoBookmark

videoBookmark.bookmarks

query Parameters
sort
string
Enum: "latest" "oldest" "popular"
limit
integer [ 1 .. 20 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

WebPublic

webPublic.appConfiguration

Responses

Response samples

Content type
application/json
"string"

webPublic.reportTypes

Responses

Response samples

Content type
application/json
[
  • null
]

webPublic.getContactInfo

Responses

Response samples

Content type
application/json
[
  • null
]

webPublic.getPageContent

query Parameters
slug
required
string [ 1 .. 100 ] characters

Responses

Response samples

Content type
application/json
[
  • null
]

webPublic.getFeed

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "links": {
    },
  • "meta": {
    }
}

webPublic.accountFollowers

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

webPublic.accountFollowing

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

webPublic.getAccountInfoByUsername

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

webPublic.getPublicSystemNotification

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

webPublic.getAccountFeed

path Parameters
id
required
string
query Parameters
sort
string
Enum: "Latest" "Popular" "Oldest"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

webPublic.getVideoTags

path Parameters
id
required
string
query Parameters
cursor
string <= 2000 characters
limit
integer [ 1 .. 30 ]

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get video comments

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Get video comment replies

path Parameters
id
required
string
query Parameters
cr
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

webPublic.getCommentById

path Parameters
videoId
required
string
commentId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

webPublic.getReplyById

path Parameters
videoId
required
string
replyId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

webPublic.showVideo

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

webPublic.getLanguagesList

Responses

Response samples

Content type
application/json
[
  • null
]