vidme

OAuth Scopes:

:auth_management : Allows access to manage authorized applications
:client_management : Allows access to manage owned applications
account : Allows access to change account settings such as avatar, username, or email.
basic : Allows access to read public information about an account such as username, avatar, and user ID.
channels : Allows access to manage subscriptions to channels.
comments : Allows access to create or delete comments.
videos : Allows access to upload, edit, and delete videos.
video_upload : Allows ability to upload videos only.
votes : Allows access to upvote or downvote videos.

Access Token:

Specify the access token using the Access-Token header

curl -H "AccessToken: abcdef0123456789"

alternatively, it may be specified using a GET or POST parameter

curl -d "token=abcdef0123456789"

Web Hooks

A web hook can be sent when a video completes encoding. Example:

curl -d"notify=web" -d"notify-id=http://domain.com/" https://api.vid.me/video/request

A POST request will be sent to the specified URL with the following signature:

User-Agent: VidMe Web Hook/1.0
Content-Type: application/json

{"notificationType":"video_success","videoId":1234,"url":"https:\/\/vid.me\/Foo"}

Notification Types:

channel-subscribed - When someone follows a channel of which you are a moderator
comment-replied-to - When someone replies to your comment
user-subscribed - When someone follows you
user-welcome - When you sign up
video-commented - When someone comments on your video
video-upvoted - When someone upvotes your video

Auth

Auth - Check

Check status of an authentication session.

https://api.vid.me/auth/check

Permission: none

Example

curl -X POST -H "AccessToken: abcdef0123456789" https://api.vid.me/auth/check

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

HTTP/1.1 200 OK
{
  "status" : false
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

Auth - Create

Create an authentication session.

https://api.vid.me/auth/create

Permission: none

Example

curl -X POST -d "username=foo&password=bar" https://api.vid.me/auth/create

Parameter

Field	Type	Description
username	String	The username of the account
password	String	The password of the account
nocookie optional	Boolean	True to not set a cookie

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please enter a valid email address.",
  "code" : "invalid_email"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "The password you entered was not valid.",
  "code" : "invalid_password"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid username.",
  "code" : "invalid_username"
}

Auth - Create

Create an authentication session.

https://api.vid.me/auth/create

Permission: none

Example

curl -X POST -d "username=foo&password=bar" https://api.vid.me/auth/create

Parameter

Field	Type	Description
username	String	The username of the account
password	String	The password of the account
remember optional	Boolean	True for extended session
nocookie optional	Boolean	True to not set a cookie

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please enter a valid email address.",
  "code" : "invalid_email"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "The password you entered was not valid.",
  "code" : "invalid_password"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid username.",
  "code" : "invalid_username"
}

Auth - Create

Deprecated since 1.2.3. Use /auth/create instead.

https://api.vid.me/user/login

Auth - Delete

Destroy an authentication session.

https://api.vid.me/auth/delete

Permission: none

Example

curl -X POST -H "AccessToken: abcdef0123456789" https://api.vid.me/auth/delete

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

Channel

Channel - Delete

Delete a channel

https://api.vid.me/channel/:channel/delete

Permission: admin

Channel - Detail

Get information about a channel

https://api.vid.me/channel/:channel

Permission: none

Example

curl https://api.vid.me/channel/1

Parameter

Field	Type	Description
channel	String	The channel ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
isFollowing	Boolean	If authenticated as a user, whether or not the user follows this channel
status	Boolean	Whether or not this request succeeded
channel	Object
channel_id	String	The ID of the channel
url	String	The unique URL fragment of the channel
full_url	String	The full URL of the channel
title	String	The title of the channel
description	String	The description of the channel
date_created	String	The date at which the channel was created
is_default	Boolean	Is this a default channel?
nsfw	String	Does the channel contain NSFW videos?
follower_count	Integer	The number of users following the channel
video_count	Integer	The number of videos in the channel

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "channel" : {
    "channel_id" : "1234",
    "url" : "aww",
    "full_url" : "https://vid.me/n/aww",
    "title" : "Aww",
    "description" : "",
    "date_created" : "2014-03-18 22:21:02"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channel - Follow

Follow a channel

https://api.vid.me/channel/:channel/follow

Permission: channels

Example

curl -X POST -d "token=123abc" https://api.vid.me/channel/1234/follow

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
channel	String	The channel ID to follow

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Channel - Followers

List users who follow specified channel

https://api.vid.me/channel/:channel/followers

Permission: none

Example

curl https://api.vid.me/channel/1/followers

Parameter

Field	Type	Description
channel	Integer	The channel ID
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
users	Object[]	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "page" : {
    "total" : 2,
    "offset" : 0,
    "limit" : 25,
  },
  "users" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channel - Hot Videos

List videos in channel ordered by hot algorithm.

https://api.vid.me/channel/:channel/hot

Permission: none

Example

curl https://api.vid.me/channel/1/hot

Parameter

Field	Type	Description
channel	Integer	The channel ID
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "channels" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channel - Is Following

Check if the authenticated user (or specified otherUser) is following a channel.

https://api.vid.me/channel/:channel/follow(/:otherUser)

Permission: none

Example
Example

curl -X GET -H "AccessToken: 123abc" https://api.vid.me/channel/1234/follow

curl -X GET https://api.vid.me/channel/1234/follow/4321

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
channel	String	The channel ID to follow

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
isFollowing	Boolean	Whether or not otherUser is following channel
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "isFollowing" : true
}

HTTP/1.1 404 Not Found
{
  "status" : true,
  "isFollowing" : false
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

> url

Headers

Global Headers

AccessToken

> String

Parameters

Parameter

channel

> String

Global Parameters

Response

Channel - Moderators

List users who are moderators of specified channel

https://api.vid.me/channel/:channel/moderators

Permission: none

Example

curl https://api.vid.me/channel/1/moderators

Parameter

Field	Type	Description
channel	Integer	The channel ID
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
users	Object[]	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "page" : {
    "total" : 2,
    "offset" : 0,
    "limit" : 25,
  },
  "users" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channel - New Videos

List videos in channel ordered by age.

https://api.vid.me/channel/:channel/new

Permission: none

Example

curl https://api.vid.me/channel/1/new

Parameter

Field	Type	Description
channel	Integer	The channel ID
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "channels" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channel - Top Videos

List videos in channel ordered by score (upvotes - downvotes).

https://api.vid.me/channel/:channel/top

Permission: none

Example

curl https://api.vid.me/channel/1/top

Parameter

Field	Type	Description
channel	Integer	The channel ID
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "channels" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channel - URL

Get a channel's URL

https://api.vid.me/channel/:channel/url

Permission: none

Example

curl -i https://api.vid.me/channel/1/url

Parameter

Field	Type	Description
channel	String	The channel ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 302 Found
Location: https://vid.me/n/some-channel
Expires: Fri, 04 Apr 2014 01:04:54
Cache-Control: max-age=86400

Channel - Unfollow

Unfollow a channel

https://api.vid.me/channel/:channel/unfollow

Permission: channels

Example

curl -X POST -d "token=123abc" https://api.vid.me/channel/1234/unfollow

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
channel	String	The channel ID to unfollow

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Channels

Channels - List

List channels

https://api.vid.me/channels

Permission: none

Example

curl https://api.vid.me/channels

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
channels	Object[]
channel_id	String	The ID of the channel
url	String	The unique URL fragment of the channel
full_url	String	The full URL of the channel
title	String	The title of the channel
description	String	The description of the channel
date_created	String	The date at which the channel was created
is_default	Boolean	Is this a default channel?
nsfw	String	Does the channel contain NSFW videos?
follower_count	Integer	The number of users following the channel
video_count	Integer	The number of videos in the channel

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "channels" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channels - Suggest

Suggest channels.

https://api.vid.me/channels/suggest

Permission: none

Example

curl https://api.vid.me/channels/suggest

Parameter

Field	Type	Description
text optional	String	Channel name or URL partial
offset optional	Integer
limit optional	Integer
number optional	Integer	(deprecated) Use limit instead

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
data	Object[]	(deprecated) Use channels instead
id	String	The ID of the channel
text	String
label	String
url	String
flags	String
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
channels	Object[]
channel_id	String	The ID of the channel
url	String	The unique URL fragment of the channel
full_url	String	The full URL of the channel
title	String	The title of the channel
description	String	The description of the channel
date_created	String	The date at which the channel was created
is_default	Boolean	Is this a default channel?
nsfw	String	Does the channel contain NSFW videos?
follower_count	Integer	The number of users following the channel
video_count	Integer	The number of videos in the channel

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "data" : [
    {}
  ],
  "channels" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Channels - Suggest

Suggest channels.

https://api.vid.me/channels/suggest

Permission: none

Example

curl https://api.vid.me/channels/suggest

Parameter

Field	Type	Description
text optional	String	Channel name or URL partial
number optional	Integer	The number of results to return, max 100

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
data	Object[]
id	String	The ID of the channel
text	String
label	String
url	String
flags	String
status	Boolean	Whether or not this request succeeded
channels	Object[]
channel_id	String	The ID of the channel
url	String	The unique URL fragment of the channel
full_url	String	The full URL of the channel
title	String	The title of the channel
description	String	The description of the channel
date_created	String	The date at which the channel was created
is_default	Boolean	Is this a default channel?
nsfw	String	Does the channel contain NSFW videos?
follower_count	Integer	The number of users following the channel
video_count	Integer	The number of videos in the channel

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "data" : [
    {}
  ],
  "channels" : [
    {},
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Channel not found",
  "code" : "channel_not_found"
}

Send a Sample Request

Comment

Comment - Create

Create a comment

https://api.vid.me/comment/create

Permission: comments

Example

curl -X POST -H "AccessToken: abc123" -d "video=1234&body=zomg" https://api.vid.me/comment/create

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID on which to comment
comment optional	String	The comment to reply to
body	String	The comment body text
at	Double	The time in the video at which the comment was made

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
comment	Object	Comment data
comment_id	String	The comment ID
video_id	String	The video the comment was posted on
user_id	String	The user that posted the comment
parent_comment_id	String	The comment to which this comment was posted as a reply
full_url	String	The full URL to the comment
body	String	The comment body text
date_created	String	The date at which the comment was created
made_at_time	Double	The time in the video at which the comment was made
score	Integer	The score of the comment
user	User	The user that posted the comment
viewerVote	Vote	The authenticated user's vote, if applicable

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "comment" : {
    "comment_id" : "89",
    "video_id" : "1",
    "user_id" : "1",
    "parent_comment_id" : null,
    "body" : "sadfgsdfg",
    "date_created" : "2014-03-12 21:10:37",
    "made_at_time" : null,
    "score" : 1
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Comment not found",
  "code" : "comment_not_found"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Comment - Create

Deprecated since 1.2.3. Use /comment/create instead.

https://api.vid.me/comments/create

Comment - Delete

Delete a comment. User must own the comment

https://api.vid.me/comment/:comment/delete

Permission: comments

Example

curl -X POST -H "AccessToken: 0123456789abcdef" https://api.vid.me/comment/1234/delete

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
comment	String	The comment to delete

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Comment not found",
  "code" : "comment_not_found"
}

Comment - Delete

Deprecated since 1.2.3. Use /comment/:comment/delete instead.

https://api.vid.me/comments/delete

Comment - Detail

Get information about a comment.

https://api.vid.me/comment/:comment

Permission: none

Example

curl https://api.vid.me/comment/1234

Parameter

Field	Type	Description
comment	String	The comment ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
comment	Object	Comment data
comment_id	String	The comment ID
video_id	String	The video the comment was posted on
user_id	String	The user that posted the comment
parent_comment_id	String	The comment to which this comment was posted as a reply
full_url	String	The full URL to the comment
body	String	The comment body text
date_created	String	The date at which the comment was created
made_at_time	Double	The time in the video at which the comment was made
score	Integer	The score of the comment
user	User	The user that posted the comment
viewerVote	Vote	The authenticated user's vote, if applicable

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "comment" : {
    "comment_id" : "89",
    "video_id" : "1",
    "user_id" : "1",
    "parent_comment_id" : null,
    "body" : "sadfgsdfg",
    "date_created" : "2014-03-12 21:10:37",
    "made_at_time" : null,
    "score" : 1
  },
  "user": {},
  "viewerVote": {}
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Comment not found",
  "code" : "comment_not_found"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Send a Sample Request

Comment - List

List comments on a video

https://api.vid.me/comments/list

Permission: none

Example

curl -d "video=1234" https://api.vid.me/comments/list

Parameter

Field	Type	Description
video	String	The video ID on which to comment
order optional	String	`comment_id`
direction optional	String	`ASC` or `DESC`

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
comments	Object[]	Comment data
comment_id	String	The comment ID
video_id	String	The video the comment was posted on
user_id	String	The user that posted the comment
parent_comment_id	String	The comment to which this comment was posted as a reply
full_url	String	The full URL to the comment
body	String	The comment body text
date_created	String	The date at which the comment was created
made_at_time	Double	The time in the video at which the comment was made
score	Integer	The score of the comment
user	User	The user that posted the comment
viewerVote	Vote	The authenticated user's vote, if applicable

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "comments" : [
      {},
      {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Comment - URL

Get a comment's url

https://api.vid.me/comment/:comment/url

Permission: none

Example

curl -i https://api.vid.me/comment/484/url

Parameter

Field	Type	Description
comment	String	The comment ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 301 Moved Permanently
Location: https://vid.me/yvi#comment-484

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Comment not found",
  "code" : "comment_not_found"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Send a Sample Request

Comment - Vote

Vote on a comment.

https://api.vid.me/comment/:comment/vote

Permission: comments

Example

curl -X POST -H "AccessToken: 0123456789abcdef" -d "value=1" https://api.vid.me/comment/1234/vote

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
comment	String	The comment on which to vote
value	Integer	The value of the vote (`1`, `0`, `-1`)

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
comment	Object	Comment data
comment_id	String	The comment ID
video_id	String	The video the comment was posted on
user_id	String	The user that posted the comment
parent_comment_id	String	The comment to which this comment was posted as a reply
full_url	String	The full URL to the comment
body	String	The comment body text
date_created	String	The date at which the comment was created
made_at_time	Double	The time in the video at which the comment was made
score	Integer	The score of the comment
user	User	The user that posted the comment
viewerVote	Vote	The authenticated user's vote, if applicable
vote	Object	Vote data
vote_id	String	The ID of the vote
comment_id	String	The comment on which the vote was made
video_id	String	The video of the comment on which the vote was made
user_id	String	The user that voted
value	Integer	The value of the vote (1, 0, -1)
date_created	String	The date at which the vote was created
date_modified	String	The date at which the vote was changed

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "comment": {
    "comment_id": "1234",
    "video_id": "5678",
    "user_id": "90",
    "parent_comment_id": null,
    "body": "aha!",
    "date_created": "2014-03-20 22:41:17",
    "made_at_time": null,
    "score": -1
  },
  "vote": {
    "vote_id": "2358",
    "comment_id": "1234",
    "video_id": "5678",
    "user_id": "90",
    "value": -1,
    "date_created": "2014-03-20 22:41:17",
    "date_modified": "2014-03-28 02:06:18"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Comment not found",
  "code" : "comment_not_found"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Comment - Vote

Deprecated since 1.2.3. Use /comment/:comment/vote instead.

https://api.vid.me/comments/vote

Geofences

Geofences - List

List geofences

https://api.vid.me/geofences

Permission: none

Example

curl https://api.vid.me/geofences

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
geofences	Object[]	Geofences data
geofence_id	String	The unique geofence identifier
title	String	The title
latitude	Double	The latitude of the center
longitude	Double	The longitude of the center
radius	Double	The radius (in meters)
date_created	String	The date of creation

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Geofences - Suggest

Suggest geofences

https://api.vid.me/geofences/suggest

Permission: none

Example usage:

curl -d "test=USC" https://api.vid.me/geofences/suggest

Parameter

Field	Type	Description
text optional	String	The text for which to search

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
geofences	Object[]	Geofences data
geofence_id	String	The unique geofence identifier
title	String	The title
latitude	Double	The latitude of the center
longitude	Double	The longitude of the center
radius	Double	The radius (in meters)
date_created	String	The date of creation

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Grab

Grab - Grab

Grab an external video.

https://api.vid.me/grab

Permission: video_upload

Example

curl -X POST
     -d "url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DRI6mLNpp-j8" 
     -d "title=baz"
     -d "description=bat"
     https://api.vid.me/grab

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
url	String	The external video URL
title optional	String	The video title
description optional	String	The video description
channel optional	Integer	The channel to which to add the video
private optional	Boolean	Should the video be considered private? Default: 0
nsfw optional	Boolean	Is the video NFSW? Default: 0

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {} // ...
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid URL.",
  "code" : "invalid_url",
  "url" : "foo/bar",
  "accessToken" : {
    "token" : "bfdmj1a9u68088kgw4ck0swgo",
    "expires" : "2004-02-12T15:19:21+00:00"
  }
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid URL.",
  "code" : "invalid_url"
}

Grab - Grab

Grab an external video.

https://api.vid.me/grab

Permission: video_upload

Example

curl -d "url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DRI6mLNpp-j8&title=baz&description=bat" https://api.vid.me/grab

Parameter

Field	Type	Description
url	String	The external video URL
title optional	String	The video title
description optional	String	The video description

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {} // ...
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid URL.",
  "code" : "invalid_url",
  "url" : "foo/bar"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid URL.",
  "code" : "invalid_url"
}

Grab - Preview

Get metadata about an external video.

https://api.vid.me/grab/preview

Permission: none

Example

curl -d "url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DRI6mLNpp-j8" https://api.vid.me/grab/preview

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
url	String	The external video URL

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "url" : "https:\/\/www.youtube.com\/watch?v=RI6mLNpp-j8",
  "title" : "Robert Scoble on Google Glass and Contextual API",
  "description" : "This is just a short interview highlight trailer snippet from my conversation with Robert Scoble where we discuss Google Glass and contextual api. You can see the full interview here: http:\/\/snglrty.co\/1eKH7pJ",
  "format" : "video"
}

HTTP/1.1 200 OK
{
  "status" : true,
  "url" : "http:\/\/giant.gfycat.com\/BlueFickleGalapagosalbatross.gif",
  "format" : "gif"
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "That link is not supported for grabbing.",
  "code" : "invalid_grab"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid URL.",
  "code" : "invalid_url"
}

Grab - Preview

Get metadata about an external video.

https://api.vid.me/grab/preview

Example

curl -d "url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DRI6mLNpp-j8" https://api.vid.me/grab/preview

Parameter

Field	Type	Description
url	String	The external video URL

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "data" : {
    "url" : "https:\/\/www.youtube.com\/watch?v=RI6mLNpp-j8",
    "title" : "Robert Scoble on Google Glass and Contextual API",
    "description" : "This is just a short interview highlight trailer snippet from my conversation with Robert Scoble where we discuss Google Glass and contextual api. You can see the full interview here: http:\/\/snglrty.co\/1eKH7pJ",
    "format" : "video"
  }
}

HTTP/1.1 200 OK
{
  "status" : true,
  "data" : {
    "url" : "http:\/\/giant.gfycat.com\/BlueFickleGalapagosalbatross.gif",
    "format" : "gif"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "That link is not supported for grabbing.",
  "code" : "invalid_grab",
  "url" : "https:\/\/foo.com\/bar"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please specify a valid URL.",
  "code" : "invalid_url"
}

Notifications

Notifications - Detail

Detail notification

https://api.vid.me/notification/:notification

Permission: account

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
notification	Object	Video upload and encoding progress information
notification_id	Integer	The notification ID
user_id	Integer	The recipient's user ID
type	String	The type of notification. Currently one of: channel-subscribed, comment-replied-to, user-subscribed, user-welcome, video-commented, video-upvoted
data	Array	Arbitrary data, varies with notification type
read	Boolean	If the notification has been read by the recipient
date_created	String	The date at which the notification was created
actor optional	User	The user that caused the notification
channel optional	Channel	The channel related to the notification. Varies by type.
comment optional	Comment	The comment related to the notification. Varies by type.
parentComment optional	Comment	The parent comment related to the notification. Varies by type.
video optional	Video	The video related to the notification. Varies by type.

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 404 Not Found
{
  "status" : false,
  "error" : "Not found",
  "code" : "not_found"
}

Notifications - List

List notifications

https://api.vid.me/notifications

Permission: account

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
notifications	Object[]	Video upload and encoding progress information
notification_id	Integer	The notification ID
user_id	Integer	The recipient's user ID
type	String	The type of notification. Currently one of: channel-subscribed, comment-replied-to, user-subscribed, user-welcome, video-commented, video-upvoted
data	Array	Arbitrary data, varies with notification type
read	Boolean	If the notification has been read by the recipient
date_created	String	The date at which the notification was created
actor optional	User	The user that caused the notification
channel optional	Channel	The channel related to the notification. Varies by type.
comment optional	Comment	The comment related to the notification. Varies by type.
parentComment optional	Comment	The parent comment related to the notification. Varies by type.
video optional	Video	The video related to the notification. Varies by type.

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Notifications - Mark Read

Mark notifications as read

https://api.vid.me/notifications/mark-read

Permission: account

Example
Example
Example

curl -X POST \
    -d "notifications=all" \
    https://api.vid.me/notifications/mark-read

curl -X POST \
    -d "notifications=[1,2,3,4]" \
    https://api.vid.me/notifications/mark-read

curl -X POST \
    -d "notifications[]=1" \
    -d "notifications[]=2" \
    https://api.vid.me/notifications/mark-read

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
notifications	String[]	A list of notification IDs, or `all`

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Notifications - Subscribe

Subscribe to notifications. Note: It is not currently possible to use the apn or gcm type.

For notify_type=web, a POST request will be sent to the specified URL when a notification is triggered. The data will be in JSON format, the same as notification/:notification (detail), plus unreadCount.

https://api.vid.me/notifications/subscribe

Permission: account

Example

curl -X POST \
    -d "token=0123456789abcdef" \
    -d "notify_type=web" \
    -d "notify_address=http://requestb.in/bin/id" \
    https://api.vid.me/notifications/subscribe

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
notify_type	String	web, apn, or gcm
notify_address	String	The web hook URL, or APN/GCM token.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean
subscription_id	String

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Notifications - Subscribe

Subscribe to notifications

https://api.vid.me/notifications/subscribe

Permission: account

Example

curl -X POST \
    -d "token=0123456789abcdef" \
    -d "notify_type=apn" \
    -d "notify_address=abcdef012345689" \
    https://api.vid.me/notifications/subscribe

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
notify_type	String	apn or gcm
notify_address	String	The APN or GCM token

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean
subscription_id	String

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Notifications - Unread Count

Get number of unread notifications

https://api.vid.me/notification/unread

Permission: account

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
unreadCount	Integer	The number of unread notifications
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 404 Not Found
{
  "status" : false,
  "error" : "Not found",
  "code" : "not_found"
}

Notifications - Unsubscribe

Unsubscribe to notifications. Note: It is not currently possible to use the apn or gcm type.

https://api.vid.me/notifications/unsubscribe

Permission: account

Example
Example

curl -X POST \
    -d "token=0123456789abcdef" \
    -d "notify_type=web" \
    -d "notify_address=http://requestb.in/bin/id" \
    https://api.vid.me/notifications/unsubscribe

curl -X POST \
    -d "token=0123456789abcdef" \
    -d "subscription_id=1234" \
    https://api.vid.me/notifications/unsubscribe

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
notify_type optional	String	web, apn, or gcm
notify_address optional	String	The web hook URL, or APN/GCM token
subscription_id optional	String	The subscription identifier

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Notifications - Unsubscribe

Unsubscribe to notifications

https://api.vid.me/notifications/unsubscribe

Permission: account

Example
Example

curl -X POST \
    -d "token=0123456789abcdef" \
    -d "notify_type=apn" \
    -d "notify_address=abcdef012345689" \
    https://api.vid.me/notifications/unsubscribe

curl -X POST \
    -d "token=0123456789abcdef" \
    -d "subscription_id=1234" \
    https://api.vid.me/notifications/unsubscribe

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
notify_type optional	String	`apn` or `gcm`
notify_address optional	String	The APN or GCM token
subscription_id optional	String	The subscription identifier

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Oauth

Oauth - Apps

List authorized applications

https://api.vid.me/oauth/apps

Permission: auth_management

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
application	Object[]	List of authorized applications
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Oauth - Authorize

Authorize an oauth application

https://api.vid.me/oauth/authorize

Permission: auth_management

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
client_id	String	The application client ID
response_type	String	The response type `token` or `code`
redirect_uri optional	String	The uri to which to redirect on success
scope	String	A space separated list of scopes
authorization	String	Either `allow` or `deny`

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
authorization	String	Either `allow` or `deny`
response_type	String	The response type `token` or `code`
access_token optional	String	The access token, if response_type is `token`
code optional	String	The code, if response_type is `code`
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "{message}",
  "code" : "invalid_param",
  "param" : "{paramName}"
}

Oauth - Clients

List owned applications

https://api.vid.me/oauth/clients

Permission: client_management

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
application	Object[]	List of owned applications
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Oauth - Edit Client

Edit an application

https://api.vid.me/oauth/client/:application_id/edit

Permission: client_management

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
application_id	String	The ID of the application (not the client_id)
name optional	String	the name of the Application encoded as a UTF-8 string [RFC 3629] with a maximum length of 100 bytes.
website optional	String	the website URI for the Application with a maximum length of 200 bytes
description optional	String	a brief description of the Application encoded as a UTF-8 string with a maximum length of 500 bytes.
organization optional	String	the name of the Organization behind the Application encoded as a UTF-8 string with a maximum length of 100 bytes.
redirect_uri_prefix optional	string	the expected prefix of the “callback” HTTP or HTTPS URI to redirect to after a User has authorized an OAuth request. Maximum length of 200 bytes.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "{message}",
  "code" : "invalid_param",
  "param" : "{paramName}"
}

Oauth - Register

https://api.vid.me/oauth/register

Permission: client_management

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
name	String	the name of the Application encoded as a UTF-8 string [RFC 3629] with a maximum length of 100 bytes.
website optional	String	the website URI for the Application with a maximum length of 200 bytes
description optional	String	a brief description of the Application encoded as a UTF-8 string with a maximum length of 500 bytes.
organization optional	String	the name of the Organization behind the Application encoded as a UTF-8 string with a maximum length of 100 bytes.
accept_terms	String	this MUST be set to yes and indicates acceptance of the Service Provider's terms_of_use
redirect_uri_prefix	string	the expected prefix of the “callback” HTTP or HTTPS URI to redirect to after a User has authorized an OAuth request. Maximum length of 200 bytes.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "{message}",
  "code" : "invalid_param",
  "param" : "{paramName}"
}

Oauth - Revoke

Revoke all access tokens for an oauth application

https://api.vid.me/oauth/revoke

Permission: auth_management

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
client_id	String	The application client ID

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "{message}",
  "code" : "invalid_param",
  "param" : "{paramName}"
}

Oauth - Token

Exchange a code for an access token

https://api.vid.me/oauth/token

Example

curl -d "grant_type=client_credentials" \
     -d "client_id=abcdef0123456789" \
     -d "client_secret=abcdef0123456789" \
     -d "code=abcdef0123456789" \
     https://api.vid.me/oauth/token

Parameter

Field	Type	Description
grant_type	String	Must be set to "client_credentials"
client_id	String	The application client ID
client_secret	String	The application client secret
code	String	The access code

Success 200

Field	Type	Description
access_token	String	The access token
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "access_token" : "fedcba9876543210fedcba9876543210",
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "{message}",
  "code" : "invalid_param",
  "param" : "{paramName}"
}

Share - Share via SMS

Share a video anonymously via SMS. Must specify either the device ID or user token that uploaded the video

https://api.vid.me/video/:video/sms

Permission: account

Example

curl -X POST -d "DEVICE=fedcba9876543210&phones[0][value]=15555555555&phones[0][name]=Arnold+Schwarzenegger" https://api.vid.me/video/1234/sms

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
phones	Object[]	A list of recipient phone numbers
name	String	The name associated with the phone number
value	String	The phone number
notify_type optional	String	Type of notification (apn, gcm) for link view notifications
notify_id optional	String	The notification token

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please select at least one valid recipient.",
  "code" : "invalid_phone"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Tags - Suggest

Suggest tags

https://api.vid.me/tags/suggest

Permission: none

Example

curl -d "text=Ga" https://api.vid.me/tags/suggest

Parameter

Field	Type	Description
text optional	String	Fragment of a tag for which to search

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "text": "Ga",
  "tags": [
    {
      "tag_id": "1",
      "text": "Gaming",
      "label": "Gaming",
      "use_count": "1"
    }
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Upload

Upload - Cancel

Cancel the upload of a video

https://api.vid.me/upload/cancel

Permission: video_upload

Example

curl -X POST -d "upload=1234&code=foo" https://api.vid.me/upload/cancel

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
upload	Integer	The upload ID
code	String	The video code

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

 HTTP/1.1 200 OK
 {
   "status" : true,
   "upload": {
     "upload_id": "63",
     "video_id": "254",
     "size_total": 100000000,
     "size_completed": 0,
     "state": "failed"
   }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Invalid Upload"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Upload - Create

Request a chunked video upload

https://api.vid.me/upload/create

Permission: video_upload

Example

curl -X POST -d "code=foo&size=13333337" https://api.vid.me/upload/create

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
code	String	The video code
size	Integer	The size of the file, in bytes

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
upload	Object	Upload data
upload_id	String	The upload ID
video_id	String	The video ID for the upload
size_total	String	The total size of the upload, in bytes
size_completed	String	The size of the completed section of the upload, in bytes
state	String	The state of the upload

Success-Response:

 HTTP/1.1 200 OK
 {
   "status" : true,
   "upload": {
     "upload_id": "63",
     "video_id": "254",
     "size_total": 100000000,
     "size_completed": 0,
     "state": "started"
   }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Invalid video state",
  "code" : "invalid_video_state"
}

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Upload - Get upload status

Check chunked upload status

https://api.vid.me/upload/status

Permission: video_upload

Example

curl https://api.vid.me/upload/status?upload=1234&code=foo

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
upload	Integer	The upload ID
code	String	The video code

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
upload	Object	Upload data
upload_id	String	The upload ID
video_id	String	The video ID for the upload
size_total	String	The total size of the upload, in bytes
size_completed	String	The size of the completed section of the upload, in bytes
state	String	The state of the upload
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "upload" : {
     "upload_id" : 1234,
     "video_id" : 4321,
     "size_total" : 133333337,
     "size_completed" : 1337,
     "state" : "started"
  },
  "video" : {} // ...
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Invalid Content-Range",
  "code" : "invalid_content_range"
}

Upload - Upload chunk

Upload a chunk of a video

https://api.vid.me/upload/chunk

Permission: video_upload

Example
Example

curl -X POST -d @upload.mp4.1 https://api.vid.me/upload/chunk?upload=1234&code=foo

curl -X POST -F filedata=@upload.mp4.1 https://api.vid.me/upload/chunk?upload=1234&code=foo

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
upload	Integer	The upload ID
code	String	The video code

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
upload	Object	Upload data
upload_id	String	The upload ID
video_id	String	The video ID for the upload
size_total	String	The total size of the upload, in bytes
size_completed	String	The size of the completed section of the upload, in bytes
state	String	The state of the upload
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

 HTTP/1.1 200 OK
 {
   "status" : true,
   "upload": {
     "upload_id": "63",
     "video_id": "254",
     "size_total": 100000000,
     "size_completed": 500000,
     "state": "started"
   },
   "video" : {} // ...
}

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Invalid Content-Range",
  "code" : "invalid_content_range"
}

User

User - Avatar URL

Get a user's avatar

https://api.vid.me/user/:user/avatar[/:type]

Example
Example

curl -i https://api.vid.me/user/9532/avatar

curl -i https://api.vid.me/user/9532/avatar/original

Parameter

Field	Type	Description
user	String	The user ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 302 Found
Location: https://d1wst0behutosd.cloudfront.net/avatars/9532.small.jpg?v2r1392862240
Expires: Fri, 04 Apr 2014 01:04:54
Cache-Control: max-age=86400

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Cover URL

Get a user's cover

https://api.vid.me/user/:user/cover[/:type]

Example
Example

curl -i https://api.vid.me/user/9532/cover

curl -i https://api.vid.me/user/9532/cover/small

Parameter

Field	Type	Description
user	String	The user ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 302 Found
Location: https://d1wst0behutosd.cloudfront.net/covers/9532.jpg?v1r1413597438
Expires: Fri, 04 Apr 2014 01:04:54
Cache-Control: max-age=86400

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Create

Create a user

https://api.vid.me/user/create

Example

curl -X POST -d "username=arnold&password=notmypassword" https://api.vid.me/user/create

Parameter

Field	Type	Description
username	String	The unique username
email optional	String	The email address
password	String	The password
claimToken optional	String	Token to claim a video
nocookie optional	Boolean	True to not set a cookie

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

User - Create

Create a user

https://api.vid.me/user/create

Example

curl -X POST -d "username=arnold&password=notmypassword" https://api.vid.me/user/create

Parameter

Field	Type	Description
username	String	The unique username
email optional	String	The email address
password	String	The password
remember optional	Boolean	To extend the duration of the authentication session
claimToken optional	String	Token to claim a video
nocookie optional	Boolean	True to not set a cookie

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

User - Create

Create a user

https://api.vid.me/user/create

Example

curl -X POST -d "username=arnold&password=notmypassword" https://api.vid.me/user/create

Parameter

Field	Type	Description
username	String	The unique username
email optional	String	The email address
password	String	The password
remember	Boolean	To extend the duration of the authentication session
claimToken optional	String	Token to claim a video

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
auth	Object	Auth data
token	String	The user authentication token
expires	String	The date at which the token expires
user_id	String	The user ID of the authentication token
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "auth" : {
    "token" : "fedcba9876543210fedcba9876543210",
    "expires" : "1543-01-01 13:33:37",
    "user_id" : "1234"
  },
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

User - Crop Avatar

Crop the current user avatar. Only affects cases where a square avatar is used. Use the 'original' avatar (e.g. avatars/1.original.jpg)

https://api.vid.me/user/:user/avatar/crop

Permission: account

Example

curl -X POST -d 'x=0' -d 'y=0' -d 'width=100' -d 'height=100' https://api.vid.me/user/1234/avatar/crop

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user for which to crop the avatar
x	String
y	String
width	String
height	String

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Detail

Get information about a user. If you have the account scope, it will contain the user's email address, if available.

https://api.vid.me/user/:user

Permission: none

Example

curl https://api.vid.me/user/1234

Parameter

Field	Type	Description
user	String	The user ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
isFollowing	Boolean	If authenticated as a user, whether or not follows specified user
isFollowedBy	Boolean	If authenticated as a user, whether or not specified user follows
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "arnold",
    "avatar" : "avatars\/1234.jpg?v3r1400000000",
    "avatar_url" : "https://d1wst0behutosd.cloudfront.net/avatars/9532.jpg?v2r1392862240"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Detail

Get information about a user.

https://api.vid.me/user/:user

Permission: none

Example

curl https://api.vid.me/user/1234

Parameter

Field	Type	Description
user	String	The user ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "arnold",
    "avatar" : "avatars\/1234.jpg?v3r1400000000",
    "avatar_url" : "https://d1wst0behutosd.cloudfront.net/avatars/9532.jpg?v2r1392862240"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Edit

Edit a user. The current password is required if a new password is specififed.

https://api.vid.me/user/:user/edit

Permission: account

Example

curl -X POST -d "username=arnold&token=123abc" https://api.vid.me/user/1234/edit

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID
username optional	String	The unique username
email optional	String	The email address
password optional	String	The new password
passwordCurrent optional	String	The current password
bio optional	String	The profile bio

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "arnold",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Edit

Edit a user

https://api.vid.me/user/:user/edit

Permission: account

Example

curl -X POST -d "username=arnold&token=123abc" https://api.vid.me/user/1234/edit

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID
username optional	String	The unique username
email optional	String	The email address
password optional	String	The password
bio optional	String	The profile bio

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "arnold",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Edit

Edit a user

https://api.vid.me/user/:user/edit

Permission: account

Example

curl -X POST -d "username=arnold&token=123abc" https://api.vid.me/user/1234/edit

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID
username optional	String	The unique username
email optional	String	The email address
password optional	String	The password

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "arnold",
    "avatar" : "avatars\/1234.jpg?v3r1400000000"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Follow

Follow a user

https://api.vid.me/user/:user/follow

Permission: account

Example

curl -X POST -d "token=123abc" https://api.vid.me/user/1234/follow

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID to follow

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Followers

Lists a user's followers

https://api.vid.me/user/:user/followers

Permission: none

Example

curl https://api.vid.me/user/1/followers

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID
offset	Integer	Page offset
limit	Integer	Page limit

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
users	Object[]	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "users" : [
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Following

Lists users a user's is following

https://api.vid.me/user/:user/following

Permission: none

Example

curl https://api.vid.me/user/1/following

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID
offset	Integer	Page offset
limit	Integer	Page limit

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
users	Object[]	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "users" : [
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Follows Channels

List channels a user follows

https://api.vid.me/user/:user/follows-channels

Permission: none

Example

curl https://api.vid.me/user/1/follows-channels

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
channels	Object[]
channel_id	String	The ID of the channel
url	String	The unique URL fragment of the channel
full_url	String	The full URL of the channel
title	String	The title of the channel
description	String	The description of the channel
date_created	String	The date at which the channel was created
is_default	Boolean	Is this a default channel?
nsfw	String	Does the channel contain NSFW videos?
follower_count	Integer	The number of users following the channel
video_count	Integer	The number of videos in the channel

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "channels" : [
    {}
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Is Following

Check if the authenticated user (or specified otherUser) is following a user.

https://api.vid.me/user/:user/follow(/:otherUser)

Permission: none

Example
Example

curl -X GET -H "AccessToken: 123abc" https://api.vid.me/user/1234/follow

curl -X GET https://api.vid.me/user/1234/follow/4321

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID to check
otherUser optional	String	The user ID to check for. Defaults to authenticated user.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
isFollowing	Boolean	Whether or not otherUser is following user

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "isFollowing" : true
}

HTTP/1.1 404 Not Found
{
  "status" : true,
  "isFollowing" : false
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Remove avatar

Remove a user avatar

https://api.vid.me/user/:user/avatar/remove

Permission: account

Example

curl -X POST https://api.vid.me/user/1234/avatar/remove

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user for which to remove the avatar

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : null
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Remove avatar

Deprecated since 1.2.3. User /user/:user/avatar/remove instead.

https://api.vid.me/user/avatar-remove

User - Remove cover

Remove a user cover

https://api.vid.me/user/:user/cover/remove

Permission: account

Example

curl -X POST https://api.vid.me/user/1234/cover/remove

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user for which to remove the avatar

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    // ...
    "cover" : null
    // ...
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Send Verification Email

Send a verification email. Must be signed in.

https://api.vid.me/user/email/send-verify

Permission: account

Example

curl -X POST -d "token=123abc" https://api.vid.me/user/email/send-verify

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Unfollow

Unfollow a user

https://api.vid.me/user/:user/unfollow

Permission: account

Example

curl -X POST -d "token=123abc" https://api.vid.me/user/1234/unfollow

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user ID to follow
token	String	The authentication token

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "User not found",
  "code" : "user_not_found"
}

User - Update avatar

Update a user avatar

https://api.vid.me/user/:user/avatar/update

Permission: account

Example

curl -X POST -F filedata=@avatar.png https://api.vid.me/user/1234/avatar/update

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user for which to remove the avatar
filedata	String	The data of the avatar

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    "username" : "foo",
    "avatar" : "avatars\/1234.jpg?v3r1396046580"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Update avatar

Deprecated since 1.2.3. User /user/:user/avatar/update instead.

https://api.vid.me/user/avatar

User - Update cover

Update a user cover photo

https://api.vid.me/user/:user/cover/update

Permission: account

Example

curl -X POST -F filedata=@cover.png https://api.vid.me/user/1234/cover/update

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
user	String	The user for which to remove the avatar
filedata	String	The data of the cover

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
user	Object	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "user" : {
    "user_id" : "1234",
    // ...
    "cover" : "cover\/1234.jpg?v3r1396046580"
    // ...
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

User - Verify Email

Verify your email address. The code is the hexadecimal part of the link sent in the verification email.

https://api.vid.me/user/email/verify

Permission: account

Example

curl -X POST -d "token=123abc" -d "code=234bcd" https://api.vid.me/user/email/verify

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
code	String	The verification code

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Users

Users - Featured

List featured users

https://api.vid.me/users/featured

Permission: none

Example

curl -d "text=a" https://api.vid.me/users/featured

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
users	Object[]	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "page": {
    "total": 123,
    "offset": 0,
    "limit": 20
  },
  "users": [
         {} // ...
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Users - Suggest

Suggest users for @mentions

https://api.vid.me/users/suggest

Permission: none

Example

curl -d "text=a" https://api.vid.me/users/suggest

Parameter

Field	Type	Description
text optional	String	The text for which to search
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
users	Object[]	User data
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url
cover	String	The cover photo url on the CDN
cover_url	String	The full cover photo url
video_views	String	The number of views on all of the user's videos
likes_count	String	The number of likes on all of the user's videos

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "text": "a",
  "users": [
         {} // ...
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Users - Suggest

Suggest users for @mentions

https://api.vid.me/users/suggest

Permission: none

Example

curl -d "text=a" https://api.vid.me/users/suggest

Parameter

Field	Type	Description
text optional	String	The text for which to search

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "text": "a",
  "users": [
       {
      "id": "3",
      "avatar": "avatars/3.jpg?v3r1393633075",
      "text": "aha",
      "label": "aha"
    }
  ]
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Users - Suggest

Deprecated since 1.2.3. Use /users/suggest instead.

https://api.vid.me/user/suggest

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Video

Claim a video

https://api.vid.me/video/:video/claim

Permission: videos

Example

curl -X POST -d "claimToken=zyxwabcdef01234" https://api.vid.me/video/1234/claim

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
claimToken	String	The claim token

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Delete

Delete a video

https://api.vid.me/video/:video/delete

Permission: videos

Example

curl -X POST https://api.vid.me/video/1234/delete

Parameter

Field	Type	Description
video	String	The video ID
token optional	String	The user authentication token
device optional	String	The device UUID.

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Delete

Delete a video

https://api.vid.me/video/:video/delete

Permission: videos

Example

curl -X POST https://api.vid.me/video/1234/delete

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
token optional	String	The user authentication token
device optional	String	The device UUID.
deleteToken optional	String	Deletion token

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Delete

Deprecated since 1.2.1. Use /video/:video/delete instead

https://api.vid.me/video/delete

Video - Detail by URL

Get information about a video by URL. The same as calling detail with the ID, see detail for more info.

https://api.vid.me/videoByUrl(/:url)

Permission: none

Example
Example

curl https://api.vid.me/videoByUrl?url=https%3A%2F%2Fvid.me%2Fyvi

curl https://api.vid.me/videoByUrl/yvi

Parameter

Field	Type	Description
url	String	The video URL

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Video - Detail

Get information about a video

https://api.vid.me/video/:video

Permission: none

Example

curl https://api.vid.me/video/1234

Parameter

Field	Type	Description
video	String	The video ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
viewerVote	Vote	If authenticated, the like/vote information for the user's vote on this video
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?
progress	Object	Video upload and encoding progress information
progress	Double	The current calculated effective progress on range [0, 1]
watchers	Object	Information about who is watching this video
total	Integer	Number of people watching the video
countries	String[]	Countries from which the video is being watched

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "1234.mp4",
    "complete_url" : "",
    "state" : "stored",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : null,
    "width" : null,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : null,
    "thumbnail_url" : null,
    "score" : 1
  },
  "progress" : {
    "progress" : 0.5
  }
}

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "videos/1234.mp4",
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  },
  "progress" : {
    "progress" : 1
  },
  "watching": 1,
  "watchingFromCountries": [
    "US"
  ],
  "viewerVote": {
    "vote_id": "12345",
    "video_id": "1234",
    "user_id": "12",
    "value": 1,
    "date_created": "2015-01-30 22:33:46",
    "date_modified": "2015-01-30 22:33:46"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Status

Deprecated since 1.2.3. Use /video/:video instead.

https://api.vid.me/status

Video - Edit

Edit a video. Must specify either token or device

https://api.vid.me/video/:video/edit

Permission: videos

Example

curl -X POST -F thumbnail=@blah.png -d "title=very+nice+video" https://api.vid.me/video/1234/edit

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
token optional	String	The user authentication token
device optional	String	The device UUID.
title optional	String	The video title
description optional	String	The video description
thumbnail optional	String	The custom thumbnail data
source optional	String	The source of the video. Must be one of `computer`, `library`, `camera`, `shareintent`, `webcam`, or a URL. Cannot be changed once set.
private optional	String	Hides from feeds and search engines
latitude optional	Double	The latitude at which the video was recorded
longitude optional	Double	The longitude at which the video was recorded
place_id optional	String	The foursquare place ID at which the video was recorded
place_name optional	String	The foursquare place name at which the video was recorded
nsfw optional	Boolean	May be set to 1 to flag as NSFW. Currently, once set, it may not be unset.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "videos/1234.mp4",
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Edit

Edit a video. Must specify either token or device

https://api.vid.me/video/:video/edit

Permission: videos

Example

curl -X POST -F thumbnail=@blah.png -d "title=very+nice+video" https://api.vid.me/video/1234/edit

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
token optional	String	The user authentication token
device optional	String	The device UUID.
title optional	String	The video title
description optional	String	The video description
thumbnail optional	String	The custom thumbnail data
source optional	String	The source of the video. Must be one of `computer`, `library`, `camera`, `shareintent`, `webcam`, or a URL. Cannot be changed once set.
private optional	String	Hides from feeds and search engines
latitude optional	Double	The latitude at which the video was recorded
longitude optional	Double	The longitude at which the video was recorded
place_id optional	String	The foursquare place ID at which the video was recorded
place_name optional	String	The foursquare place name at which the video was recorded

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "videos/1234.mp4",
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Edit

Edit a video. Must specify either token or device

https://api.vid.me/video/:video/edit

Permission: videos

Example

curl -X POST -F thumbnail=@blah.png -d "title=very+nice+video" https://api.vid.me/video/1234/edit

Parameter

Field	Type	Description
video	String	The video ID
token optional	String	The user authentication token
device optional	String	The device UUID.
title optional	String	The video title
description optional	String	The video description
thumbnail optional	String	The custom thumbnail data
source optional	String	The source of the video. Must be one of computer, library, camera, shareintent, webcam, or a URL. Cannot be changed once set.
private optional	String	Hides from feeds and search engines

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "videos/1234.mp4",
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Edit

Deprecated since 1.2.1. Use /video/:video/edit instead

https://api.vid.me/video/edit

Video - Flag

Flag a video. Must specify either token or device

https://api.vid.me/video/:video/flag

Permission: videos

Example

curl -X POST 
     -H "AccessToken: abcdef0123456789" 
     -d "value=1" https://api.vid.me/video/1234/flag

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
value	Integer	The flag state. Defaults to 1
device optional	String	The device UUID.

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
flagged optional	Boolean	The current state of your flag
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "flagged" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "videos/1234.mp4",
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Flag

Flag a video. Must specify either token or device

https://api.vid.me/video/:video/flag

Permission: videos

Example

curl -X POST  "token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" https://api.vid.me/video/1234/flag

Parameter

Field	Type	Description
video	String	The video ID
flagged	Integer	The flag state. Defaults to 1
token optional	String	The user authentication token
device optional	String	The device UUID.

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : "videos/1234.mp4",
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Random Video

Return a random video. See detail for response format.

https://api.vid.me/video/random

Permission: none

Example

curl -X POST https://api.vid.me/video/random

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Video - Remove From Channel

Remove a video from a channel. Must be the owner or a network moderator.

https://api.vid.me/video/:video/remove-channel

Permission: videos

Example

curl -X POST https://api.vid.me/video/1234/remove-channel

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

Video - Request

Requests a video identity. If using this method to upload a video, do not send video metadata to the upload method.

For notify=web, a POST request will be sent to the specified URL when the video is ready. The data will be in JSON format, the same as video/:video (detail).

https://api.vid.me/video/request

Permission: video_upload

Example
Example

curl -X POST -d "size=1333337&video_title=foo" https://api.vid.me/video/request

curl -X POST -d "size=1333337&video_title=foo&mode=chunked" https://api.vid.me/video/request

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Video Metadata

Field	Type	Description
channel optional	Integer	The ID of the channel in which the video should be added
filename optional	String	The name of the file.
size optional	Integer	The size of the video being requested.
title optional	String	The title of the video
description optional	String	The description of the video
source optional	String	The source of the video. Must be one of computer, library, camera, shareintent, webcam, or a URL. Cannot be changed once set.
private optional	Boolean	Is the video not visible in lists and search engines?
notify optional	String	Type of notification to send when video is ready (apn, gcm, web)
notify-id optional	String	The address to which to send the notification. This is the token/ID for apn and gcm, or a URL for web.
latitude optional	Double	The latitude at which the video was recorded
longitude optional	Double	The longitude at which the video was recorded
place_id optional	String	The foursquare place ID at which the video was recorded
place_name optional	String	The foursquare place name at which the video was recorded
nsfw optional	Boolean	May be set to 1 to flag as NSFW. Currently, once set, it may not be unset.

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : null,
    "complete_url" : null,
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  },
  "maxSize" : 268435456,
  "uploadId" : null
}

HTTP/1.1 200 OK
{
  "status" : true,
  "id" : "1234",
  "code" : "Foo",
  "url" : "https:\/\/vid.me\/Foo",
  "video" : {
    "video_id" : "61",
    "url" : "Foo",
    "complete" : null,
    "state" : "initial",
    "title" : "",
    "description" : null,
    "duration" : null,
    "height" : null,
    "width" : null,
    "date_created" : "2014-03-18 21:27:16",
    "date_stored" : "0000-00-00 00:00:00",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 0,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : null,
    "score" : 0
  },
  "maxSize" : 268435456,
  "maxSizeMB" : 256,
  "uploadId" : 2358,
  "accessToken" : {
    "token" : "bfdmj1a9u68088kgw4ck0swgo",
    "expires" : "2004-02-12T15:19:21+00:00"
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please upload a file smaller than 256MB"
}

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

Video - Request

Requests a video identity. If using this method to upload a video, do not send video metadata to the upload method.

https://api.vid.me/video/request

Permission: video_upload

Example
Example

curl -X POST -d "size=1333337&video_title=foo" https://api.vid.me/video/request

curl -X POST -d "size=1333337&video_title=foo&mode=chunked" https://api.vid.me/video/request

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Video Metadata

Field	Type	Description
channel optional	Integer	The ID of the channel in which the video should be added
filename optional	String	The name of the file.
size optional	Integer	The size of the video being requested.
title optional	String	The title of the video
description optional	String	The description of the video
source optional	String	The source of the video. Must be one of computer, library, camera, shareintent, webcam, or a URL. Cannot be changed once set.
private optional	Boolean	Is the video not visible in lists and search engines?
notify optional	String	Type of notification to send when video is ready (apn, gcm, web)
notify-id optional	String	The address to which to send the notification. This is the token/ID for apn and gcm, or a URL for web.
latitude optional	Double	The latitude at which the video was recorded
longitude optional	Double	The longitude at which the video was recorded
place_id optional	String	The foursquare place ID at which the video was recorded
place_name optional	String	The foursquare place name at which the video was recorded
nsfw optional	Boolean	May be set to 1 to flag as NSFW. Currently, once set, it may not be unset.

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:
Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "full_url" : "https://vid.me/Foo",
    "embed_url" : "https://vid.me/e/Foo",
    "complete" : null,
    "complete_url" : null,
    "state" : "success",
    "title" : "",
    "description" : null,
    "duration" : 9,
    "height" : 240,
    "width" : 320,
    "date_created" : "2014-03-18 22:21:02",
    "date_stored" : "2014-03-18 22:21:02",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 1,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : "thumbnails/1234.png?v1r14000000000",
    "thumbnail_url" : "https://d1lpjom9omu2wc.cloudfront.net/thumbnails/1234.png?v1r14000000000",
    "score" : 1
  },
  "maxSize" : 268435456,
  "uploadId" : null
}

HTTP/1.1 200 OK
{
  "status" : true,
  "id" : "1234",
  "code" : "Foo",
  "url" : "https:\/\/vid.me\/Foo",
  "video" : {
    "video_id" : "61",
    "url" : "Foo",
    "complete" : null,
    "state" : "initial",
    "title" : "",
    "description" : null,
    "duration" : null,
    "height" : null,
    "width" : null,
    "date_created" : "2014-03-18 21:27:16",
    "date_stored" : "0000-00-00 00:00:00",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 0,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : null,
    "score" : 0
  },
  "maxSize" : 268435456,
  "maxSizeMB" : 256,
  "uploadId" : 2358
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please upload a file smaller than 256MB"
}

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

Video - Request

Deprecated since 1.2.3

https://api.vid.me/request

Video - Thumbnail

Get a video's thumbnail

https://api.vid.me/video/:video/thumbnail

Permission: none

Example

curl -i https://api.vid.me/video/1234/thumbnail

Parameter

Field	Type	Description
video	String	The video ID

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success-Response:

HTTP/1.1 302 Found
Location: https://d1wst0behutosd.cloudfront.net/thumbnails/1234.png?v1r1393633605
Expires: Fri, 04 Apr 2014 01:04:54
Cache-Control: max-age=86400

Video - Update title

Updates a video's title. The device ID from which the video was uploaded must be specified.

https://api.vid.me/video/update-title

Example

curl -X POST -d "code=bAr&device=fedcba9876543210&title=baz" https://api.vid.me/video/update-title

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
code	String	The unique code of the video
device	String	The device UUID
title	String	The title of the video

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true
}

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Invalid video or device",
  "code" : "invalid_request"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video does not exist",
  "code" : "not_found"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Unable to update title",
  "code" : "not_allowed"
}

Video - Upload

If using in conjunction with /video/request and the code parameter, video metadata should be sent to the request method instead.

https://api.vid.me/video/upload

Permission: video_upload

Example
Example

curl -X POST -F filedata=blah.avi -d "code=Foo" https://api.vid.me/video/upload

curl -X POST -F filedata=blah.avi -d "filename=blah.avi&title=blah" https://api.vid.me/video/upload

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
filedata	String	The binary data of the video
code optional	String	The unique code of the video returned by request

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Video Metadata

Field	Type	Description
channel optional	Integer	The ID of the channel in which the video should be added
filename optional	String	The name of the file.
size optional	Integer	The size of the video being requested.
title optional	String	The title of the video
description optional	String	The description of the video
source optional	String	The source of the video. Must be one of computer, library, camera, shareintent, webcam, or a URL. Cannot be changed once set.
private optional	Boolean	Is the video not visible in lists and search engines?
notify optional	String	Type of notification to send when video is ready (apn, gcm, web)
notify-id optional	String	The address to which to send the notification. This is the token/ID for apn and gcm, or a URL for web.
latitude optional	Double	The latitude at which the video was recorded
longitude optional	Double	The longitude at which the video was recorded
place_id optional	String	The foursquare place ID at which the video was recorded
place_name optional	String	The foursquare place name at which the video was recorded
nsfw optional	Boolean	May be set to 1 to flag as NSFW. Currently, once set, it may not be unset.

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "id" : "1234",
  "code" : "Foo",
  "url" : "https:\/\/vid.me\/Foo",
  "duration" : 13.37,
  "video" : {
    "video_id" : "1234",
    "url" : "Foo",
    "complete" : null,
    "state" : "initial",
    "title" : "Bar",
    "description" : null,
    "duration" : null,
    "height" : null,
    "width" : null,
    "date_created" : "2014-03-18 20:50:21",
    "date_stored" : "0000-00-00 00:00:00",
    "date_completed" : "0000-00-00 00:00:00",
    "comment_count" : 0,
    "view_count" : 0,
    "version" : 2,
    "nsfw" : false,
    "thumbnail" : null,
    "score" : 0
  }
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please choose a valid video or GIF to upload.",
  "code" : "no_file"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please choose a valid video or GIF to upload.",
  "code" : "no_extension"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Please choose a valid video or GIF to upload.",
  "code" : "invalid_mime",
  "mime" : "text\/plain"
}

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video has already been uploaded.",
  "code" : "already_uploaded"
}

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

Video - Upload

Deprecated since 1.2.3. Use /video/upload instead.

https://api.vid.me/upload

Video - Vote

Vote on a video

https://api.vid.me/video/:video/vote

Permission: votes

Example

curl -X POST -d "value=1&at=2.30" https://api.vid.me/video/1234/vote

Global Headers

Field	Type	Description
AccessToken	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
video	String	The video ID
value	Integer	The value of the vote (1\|0\|-1)
at	Double	The time in the video at which the vote was made

Global Parameters

Field	Type	Description
token	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
vote	Object	Vote data
vote_id	String	The ID of the vote
video_id	String	The video on which the vote was made
user_id	String	The user that voted
value	Integer	The value of the vote (1, 0, -1)
date_created	String	The date at which the vote was created
date_modified	String	The date at which the vote was changed
video	Object	The video data
video_id	String	The video ID
url	String	The video code, used for the URL
full_url	String	The full URL to the video page
embed_url	String	The full URL to the video embed page
complete	String	The path on the CDN where the completed video is stored
complete_url	String	The full URL to the completed, encoded video object
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
thumbnail_url	String	The full URL to the video thumbnail
score	Integer	The score of the video
private	Boolean	Is the video visible in lists and search engines?

Success-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "vote": {
    "vote_id": "2358",
    "video_id": "5678",
    "user_id": "90",
    "value": -1,
    "date_created": "2014-03-20 22:41:17",
    "date_modified": "2014-03-28 02:06:18"
  },
  "video" : {} // ...

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Error-Response:
Error-Response:
Error-Response:

HTTP/1.1 400 Bad Request
{
  "status" : false,
  "error" : "Video not found",
  "code" : "video_not_found"
}

HTTP/1.1 405 Method Not Allowed
{
  "status" : false,
  "error" : "Method not allowed",
  "code" : "method_not_allowed"
}

HTTP/1.1 403 Forbidden
{
  "status" : false,
  "error" : "Forbidden",
  "code" : "forbidden"
}

Video - Vote

Deprecated since 1.2.3. Use /video/:video/vote instead.

https://api.vid.me/video/vote

Videos

Videos - Featured Videos

List featured videos. Ordrered by date featured, descending.

https://api.vid.me/videos/featured

Permission: none

Example

curl https://api.vid.me/videos/featured

Parameter

Field	Type	Description
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Following Videos

A video feed. If not signed in, displays videos in the list of default channels. If signed in, displays videos posted by users and channels that the user has followed.

https://api.vid.me/videos/following

Permission: none

Example

curl https://api.vid.me/videos/feed

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
maxVideoId optional	Integer
maxDateCompleted optional	Integer
limit optional	Integer
locationOnly optional	Integer

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

> url

Headers

Global Headers

AccessToken

> String

Parameters

Parameter

maxVideoId

> Integer

maxDateCompleted

> Integer

limit

> Integer

locationOnly

> Integer

Global Parameters

Response

Videos - Frontpage Videos

List videos from the frontpage by the specified ordering algorithm.

https://api.vid.me/videos/frontpage/:order

Permission: none

Example

curl https://api.vid.me/videos/frontpage

Parameter

Field	Type	Description
order optional	String	One of: hot, new, top. Defaults to hot (ordered by likes decaying over time)
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Frontpage Videos

List videos from the frontpage by the specified ordering algorithm.

https://api.vid.me/videos/frontpage/:order

Permission: none

Example

curl https://api.vid.me/videos/frontpage

Parameter

Field	Type	Description
order optional	String	One of: hot, new. Defaults to hot (ordered by likes decaying over time)
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Hot Videos

List videos ordered by hot algorithm (votes decaying over time). Note: trending videos has moved to /videos/trending

https://api.vid.me/videos/hot/:subindex

Permission: none

Example

curl https://api.vid.me/videos/hot/frontpage

Parameter

Field	Type	Description
subindex optional	String	One of main, frontpage, featured. Defaults to main (all videos)
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Hot Videos

List videos ordered by hot algorithm (views decaying over time).

https://api.vid.me/videos/hot

Permission: none

Example

curl https://api.vid.me/videos/hot

Parameter

Field	Type	Description
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Liked Videos

List videos a user has liked.

https://api.vid.me/videos/likes

Permission: none

Example

curl https://api.vid.me/videos/likes?user=9532

Parameter

Field	Type	Description
user optional	Integer	List videos by user ID
offset optional	Integer	Result offset
limit optional	Integer	Result limit (1-100)

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - List Videos

List a video feed. If not signed in, displays videos in the list of default channels. If signed in, displays videos posted by users and channels that the user has followed. All filters are joined with a logical AND.

https://api.vid.me/videos/list

Permission: none

Example

curl https://api.vid.me/videos/list

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Filters

Field	Type	Description
user optional	Integer	List videos by user ID
device optional	String	List videos by device ID
state optional	String	Filter results by state
nsfw optional	Ternary	Filter results by NSFW
moderated optional	Ternary	Filter results by moderated. Must specify `user` and be authenticated as that user or specify `device` to use this option. Omit or use -1 for any. Forced to 1 if not authenticated.
private optional	Ternary	Filter results by private. Must specify `user` and be authenticated as that user or specify `device` to use this option. Omit or use -1 for any. Forced to 0 if not authenticated.
location optional	Boolean	Only results that have a location.

Order

Field	Type	Description
order optional	Integer	May be one of `video_id`, `view_count`, `date_completed`, `score`
direction optional	Integer	`ASC` or `DESC`

Page

Field	Type	Description
maxVideoId optional	Integer	Return only results with an ID less than this
minVideoId optional	Integer	Return only results with an ID more than this
offset optional	Integer	Result offset
limit optional	Integer	Result limit (1-100)

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - List Videos

https://api.vid.me/videos/list

Permission: none

Example

curl https://api.vid.me/videos/list

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Filters

Field	Type	Description
user optional	Integer	List videos by user ID
device optional	String	List videos by device ID
state optional	String	Filter results by state
nsfw optional	Ternary	Filter results by NSFW
moderated optional	Ternary	Filter results by moderated. Must specify `user` and be authenticated as that user or specify `device` to use this option. Omit or use -1 for any. Forced to 1 if not authenticated.
private optional	Ternary	Filter results by private. Must specify `user` and be authenticated as that user or specify `device` to use this option. Omit or use -1 for any. Forced to 0 if not authenticated.
location optional	Boolean	Only results that have a location.

Order

Field	Type	Description
order optional	Integer	May be one of `video_id`, `view_count`, `date_completed`
direction optional	Integer	`ASC` or `DESC`

Page

Field	Type	Description
maxVideoId optional	Integer	Return only results with an ID less than this
minVideoId optional	Integer	Return only results with an ID more than this
offset optional	Integer	Result offset
limit optional	Integer	Result limit (1-100)

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Location Search

List videos near a point

https://api.vid.me/videos/location

Permission: none

Parameter

Field	Type	Description
latitude	Double	Latitude of the center of search
longitude	Double	Longitude of the center of search
geofence optional	Integer	A geofence identifier (instead of latitude, longitude, and distance)
from optional	Distance	Minimum distance of center (e.g. 1km or 2mi). Use with to.
to optional	Distance	Maximum distance from center (e.g. 5km or 10mi). Use with from.
distance optional	Distance	Maximum distance from center (e.g. 5km or 10mi). Use with alone.
offset optional	Integer	Result offset
limit optional	Integer	Result limit
order optional	String	null, likes_count, hot_score

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Videos - Location Search

List videos near a point

https://api.vid.me/videos/location

Parameter

Field	Type	Description
latitude	Double
longitude	Double
from optional	Distance
to optional	Distance
distance optional	Distance
offset optional	Integer
limit optional	Integer
order optional	String	One of (null, likes_count, hot_score)

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Videos - Search

Search for videos

https://api.vid.me/videos/search

Permission: none

Example

curl https://api.vid.me/videos/search?query=google

Parameter

Field	Type	Description
query	String	The string query for which to search
nsfw optional	String	Include NSFW results. If ommited, defaults to setting in user account

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
parameters	Object	Filer parameters
query	String	The given string query
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Success-Response:
Error-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "page": {
    "total": 2,
    "offset": 0,
    "limit": 20
  },
  "parameters": {
    "query": "findme"
  },
  "videos" : [
    {}, // ...
    {} // ...
  ]
}

HTTP/1.1 503 Service Unavailable
{
  "status" : false,
  "error" : "Service Unavailable",
  "code" : "service_unavailable"
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Search

Search for videos

https://api.vid.me/videos/search

Permission: none

Example

curl https://api.vid.me/videos/search?query=google

Parameter

Field	Type	Description
query	String	The string query for which to search

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
page	Object
total	Integer	The total number of results
offset	Integer	The page offset
limit	Integer	The requested page size
parameters	Object	Filer parameters
query	String	The given string query
status	Boolean	Whether or not this request succeeded
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Success-Response:
Error-Response:

HTTP/1.1 200 OK
{
  "status" : true,
  "page": {
    "total": 2,
    "offset": 0,
    "limit": 20
  },
  "parameters": {
    "query": "findme"
  },
  "videos" : [
    {}, // ...
    {} // ...
  ]
}

HTTP/1.1 503 Service Unavailable
{
  "status" : false,
  "error" : "Service Unavailable",
  "code" : "service_unavailable"
}

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Videos - Trending Videos

List videos ordered by hot algorithm (views decaying over time). Note: this used to be /videos/hot

https://api.vid.me/videos/trending

Permission: none

Example

curl https://api.vid.me/videos/hot

Parameter

Field	Type	Description
offset optional	Integer
limit optional	Integer

Global Parameters

Field	Type	Description
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

Videos - Video Feed

Renamed to /videos/following. /videos/feed is provided for compatibility.

https://api.vid.me/videos/feed

Videos - Video Feed

List a video feed. If not signed in, displays videos in the list of default channels. If signed in, displays videos posted by users and channels that the user has followed.

https://api.vid.me/videos/feed

Permission: none

Example

curl https://api.vid.me/videos/feed

Global Headers

Field	Type	Description
AccessToken optional	String	The user authentication token. May use token parameter instead.

Parameter

Field	Type	Description
maxVideoId optional	Integer
maxDateCompleted optional	Integer
limit optional	Integer
locationOnly optional	Integer

Global Parameters

Field	Type	Description
token optional	String	The user authentication token. May use AccessToken header instead.
DEVICE optional	String	The device UUID
PLATFORM optional	String	The device platform (ios\|android\|web)

Success 200

Field	Type	Description
status	Boolean	Whether or not this request succeeded
page	Object
total	Integer	Total items matching query
limit	Integer	The effective result limit
offset	Integer	The effective result offset
videos	Object[]	Videos
video_id	String	The video ID
url	String	The video code, used for the URL
complete	String	The path on the CDN where the completed video is stored
state	String	The state of the video
title	String	The video title
description	String	The video description
duration	Double	The duration of the video
height	Integer	The height of the video in pixels
width	Integer	The width of the video in pixels
date_created	String	The date at which the video was created or upload requested
date_stored	String	The date at which the video was stored for encoding
date_completed	String	The date at which the video oompleted encoding and was available to view
comment_count	Integer	The number of comments on the video, including replies
view_count	Integer	The number of times the video has been viewed
version	Integer	The version of the video
nsfw	Boolean	Whether or not the video should be considered "Not safe for work"
thumbnail	String	The path on the CDN where the video thumbnail/poster is stored
score	Integer	The score of the video
user	Object	The video owner
user_id	String	The user ID
username	String	The unique username
full_url	String	The full URL to the user's profile
avatar	String	The avatar url on the CDN
avatar_url	String	The full avatar url

Error 4xx

Field	Type	Description
status	Boolean	true for success, false for failure
error	String	An error message explaining the error
code	String	An error code

Send a Sample Request

> url

Headers

Global Headers

AccessToken

> String

Parameters

Parameter

maxVideoId

> Integer

maxDateCompleted

> Integer

limit

> Integer

locationOnly

> Integer

Global Parameters

Response

Generated with apidoc 0.12.1 - 2015-04-09T18:41:38.405Z

vidme

OAuth Scopes:

Access Token:

Web Hooks

Notification Types:

Auth

Auth - Check

Global Headers

Global Parameters

Success 200

Error 4xx

Auth - Create

Parameter

Global Parameters

Success 200

Error 4xx

Auth - Create

Parameter

Global Parameters

Success 200

Error 4xx

Auth - Create

Auth - Delete

Global Headers

Global Parameters

Success 200

Error 4xx

Channel

Channel - Delete

Channel - Detail

Parameter

Global Parameters

Success 200

Error 4xx

Send a Sample Request

Parameters

Parameter

Global Parameters

Response X

Channel - Follow

Global Headers

Parameter

Global Parameters

Success 200

Error 4xx

Channel - Followers

Parameter

Global Parameters

Success 200

Error 4xx

Send a Sample Request

Parameters

Parameter

Global Parameters

Response X

Channel - Hot Videos

Parameter

Global Parameters

Success 200

Error 4xx

Send a Sample Request

Parameters

Parameter

Global Parameters

Response X

Channel - Is Following

Global Headers

Parameter

Global Parameters

Success 200

Error 4xx

Send a Sample Request

Headers

Global Headers

Parameters

Parameter

Global Parameters

Response X

Channel - Moderators

Parameter

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response