API docs by Redocly

sharing (1.0.0)

Download OpenAPI specification:Download

Sharing has a really interesting name

Authenticate user and login

Authorizations:
None
Request Body schema: application/json
required

User credentials

email
required
string
password
required
string

Responses

Request samples

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

Response samples

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

Register a new user

Authorizations:
None
Request Body schema: application/json
required

User information for registration

email
required
string
password
required
string
name
required
string

Responses

Request samples

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

Response samples

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

Get user by ID

Authorizations:
NonebearerAuth
path Parameters
user_id
required
string <int64>

ID of the user to retrieve

header Parameters
Authorization
required
string

Bearer token for authentication

Responses

Response samples

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

Get users

Authorizations:
NonebearerAuth
query Parameters
ids
Array of strings <int64> [ items <int64 > ]

IDs of the users to retrieve

header Parameters
Authorization
string

Bearer token for authentication

Responses

Response samples

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

Update user profile

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
name
string
bio
string
avatar_url
string
bg_url
string

Responses

Request samples

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

Response samples

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

Get followers of a user

Authorizations:
NonebearerAuth
path Parameters
user_id
required
string <int64>

ID of the user to retrieve

query Parameters
page
string <int64>

page number

limit
integer <int32>

limit number

header Parameters
Authorization
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "all_count": 0,
  • "next_page": "string"
}

Get users followed by a user

Authorizations:
NonebearerAuth
path Parameters
user_id
required
string <int64>

ID of the user to retrieve

query Parameters
page
string <int64>

page number

limit
integer <int32>

limit number

header Parameters
Authorization
string

Bearer token for authentication

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "all_count": 0,
  • "next_page": "string"
}

generate new asset pre-signed url to upload

Authorizations:
bearerAuth
Request Body schema: application/json
required

asset information

string

Responses

Request samples

Content type
application/json
{
  • "kind": "video"
}

Response samples

Content type
application/json
{}

Follow or unfollow a user

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
required

User ID and action to perform

user_id
required
string <int64>
action
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "action": 0
}

Response samples

Content type
application/json
{ }

Create a comment

Authorizations:
NonebearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
required

Comment information

video_id
required
string <int64> >= 0
action
required
integer <int32> >= 0
comment_text
string
comment_id
string <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "video_id": "string",
  • "action": 0,
  • "comment_text": "string",
  • "comment_id": "string"
}

Response samples

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

Get comments for a video

Authorizations:
bearerAuth
header Parameters
Authorization
string

Bearer token for authentication

Request Body schema: application/json
required

Comment information

video_id
required
string <int64> >= 0
page
string <int64> >= 0
limit
integer <int32> >= 0

Responses

Request samples

Content type
application/json
{
  • "video_id": "string",
  • "page": "string",
  • "limit": 0
}

Response samples

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

Get video by ID

Authorizations:
bearerAuth
path Parameters
video_id
required
string <int64>

ID of the video to retrieve

header Parameters
Authorization
string

Bearer token for authentication

Responses

Response samples

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

Get videos by user ID

Authorizations:
bearerAuth
header Parameters
Authorization
string

Bearer token for authentication

Request Body schema: application/json
required

User ID and action to perform

user_id
required
string <int64> >= 0
limit
integer <int32> >= 0
page
string <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "limit": 0,
  • "page": "string"
}

Response samples

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

Get liked videos by user ID

Authorizations:
bearerAuth
header Parameters
Authorization
string

Bearer token for authentication

Request Body schema: application/json
required

User ID and action to perform

user_id
required
string <int64> >= 0
limit
integer <int32> >= 0
page
string <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "limit": 0,
  • "page": "string"
}

Response samples

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

Like a video

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
required

Video ID and action to perform

video_id
required
string <int64>
action
required
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Get recent videos by user ID

Authorizations:
bearerAuth
header Parameters
Authorization
string

Bearer token for authentication

Request Body schema: application/json
required

User ID and action to perform

limit
integer <int32> >= 0
page
string <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "page": "string"
}

Response samples

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

Upload a video

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
title
string
description
string
category
string
video_url
string
cover_url
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "category": "string",
  • "video_url": "string",
  • "cover_url": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{ }

Send a message

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
required

Message information

to_user_id
required
string <int64> >= 0
content
required
string
action_type
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "to_user_id": "string",
  • "content": "string",
  • "action_type": 0
}

Response samples

Content type
application/json
{ }

Get messages

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Bearer token for authentication

Request Body schema: application/json
required

Message information

to_user_id
string <int64> >= 0
page
string <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "to_user_id": "string",
  • "page": "string"
}

Response samples

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