Taringa! Brainiac API documentation
http://beta.taringa.net/api
/auth
/oauth/v2
/user
get /user/about
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'user',
tid: 1,
username: 'test',
firstname: 'first name',
followers: 0,
following: 0,
lastname: 'last name',
birthday: '1988-05-27',
avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
site: 'http://hello.w0r1d.net/',
gender: 'm',
country: 'AR',
message: 'Hello World!',
rank: 'User',
suspended: false,
}
get /user/{username}/about
URI Parameters
- username: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'user',
tid: 1,
username: 'test',
firstname: 'first name',
followers: 0,
following: 0,
lastname: 'last name',
birthday: '1988-05-27',
avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
site: 'http://hello.w0r1d.net/',
gender: 'm',
country: 'AR',
message: 'Hello World!',
rank: 'User',
suspended: false,
}
post /user/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"firstname": { "type": "string" },
"lastname": { "type": "string" },
"birthday": { "type": "string" },
"avatar": { "type": "string" },
"background": { "type": "string" },
"site": { "type": "string" },
"gender": { "type": "string" },
"country": { "type": "string" },
"message": { "type": "string" },
"email": { "type": "string" },
"password": { "type": "string" },
"captcha": { "type": "string" }
},
"required": ["username", "firstname", "lastname", "email"],
"additionalProperties": false
}
HTTP status code 201
post /user/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"username": { "type": "string" },
"firstname": { "type": "string" },
"lastname": { "type": "string" },
"birthday": { "type": "string" },
"avatar": { "type": "string" },
"background": { "type": "string" },
"site": { "type": "string" },
"gender": { "type": "string" },
"country": { "type": "string" },
"message": { "type": "string" },
"wallpaper": { "type": "string" },
"wallpaperMode": { "type": "string" },
"migrated": { "type": "array" },
"tyc": { "type": "string" },
"customRankFrame": { "type": "string" },
"customLevelFrame": { "type": "number" },
"deletedOn": { "type": "string" }
},
"additionalProperties": false
}
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'user',
tid: 1,
username: 'test',
firstname: 'first name',
followers: 0,
following: 0,
lastname: 'last name',
birthday: '1988-05-27',
avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
site: 'http://hello.w0r1d.net/',
gender: 'm',
country: 'AR',
message: 'Hello World!',
rank: 'User',
}
post /user/{username}/moderate
URI Parameters
- username: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"reason": { "type": "string" },
"user": {
"type": "object",
"properties": {
"avatar": { "type": "string" },
"background": { "type": "string" },
"wallpaper": { "type": "string" }
},
"additionalProperties": false
}
},
"additionalProperties": false
}
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'user',
tid: 1,
username: 'test',
firstname: 'first name',
followers: 0,
following: 0,
lastname: 'last name',
birthday: '1988-05-27',
avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
site: 'http://hello.w0r1d.net/',
gender: 'm',
country: 'AR',
message: 'Hello World!',
rank: 'User',
}
post /user/settings/selectedFeed/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/firstsession/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/skipTutorial/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/siteNotifications/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/enableVideoAutoplay/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/enableBetaTesting/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/enableChatRequests/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/disableChatNotifications/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/enableDarkTheme/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/newsletter/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/lang/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/ntf/{device}/patch
URI Parameters
- device: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/nsfw/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/settings/push/patch
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"notifications": {
"type": "object",
"properties": {
"comment-created": {
"type": "boolean"
},
"comment-reply-created": {
"type": "boolean"
},
"comment-voted": {
"type": "boolean"
},
"user-subscribed": {
"type": "boolean"
},
"story-voted": {
"type": "boolean"
},
"story-created": {
"type": "boolean"
},
"story-shared": {
"type": "boolean"
},
"user-followed": {
"type": "boolean"
},
"user-mentioned": {
"type": "boolean"
},
"user-requested-subscription": {
"type": "boolean"
},
"user-was-accepted": {
"type": "boolean"
},
"message-created": {
"type": "boolean"
}
},
"additionalProperties": false
},
"firstSession": {
"oneOf": [
{
"type": "null"
},
{
"enum": [
"interests",
"follow-users",
"done"
]
}
]
},
"skipTutorial": {
"type": "boolean"
},
"enableSiteNotifications": {
"type": "boolean"
},
"enableVideoAutoplay": {
"type": "boolean"
},
"enableBetaTesting": {
"type": "boolean"
},
"enableChatRequests": {
"type": "boolean"
},
"disableChatNotifications": {
"type": "boolean"
},
"enableDarkTheme": {
"type": "boolean"
},
"newsletter": {
"type": "boolean"
},
"nsfw": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"lang": {
"enum": [
"es",
"en"
]
},
"selectedFeed": {
"type": "string",
"enum": [
"followed-and-subscribed-channels",
"followed",
"followed-profile",
"followed-profile-and-subscribed-channels",
"followed-profile-and-common-subscribed-channels",
"subscribed-channels"
]
}
},
"additionalProperties": false
}
post /user/{username}/patch
URI Parameters
- username: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"username": { "type": "string" },
"firstname": { "type": "string" },
"lastname": { "type": "string" },
"birthday": { "type": "string" },
"avatar": { "type": "string" },
"background": { "type": "string" },
"site": { "type": "string" },
"gender": { "type": "string" },
"country": { "type": "string" },
"message": { "type": "string" },
"wallpaper": { "type": "string" },
"wallpaperMode": { "type": "string" },
"migrated": { "type": "array" },
"tyc": { "type": "string" },
"customRankFrame": { "type": "string" },
"customLevelFrame": { "type": "number" },
"deletedOn": { "type": "string" }
},
"additionalProperties": false
}
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'user',
tid: 1,
username: 'test',
firstname: 'first name',
followers: 0,
following: 0,
lastname: 'last name',
birthday: '1988-05-27',
avatar: 'https://r.kn3.net/taringa_defaults/avatares/m/5.jpg',
background: 'https://r.kn3.net/taringa_defaults/avatares/m/6.jpg',
site: 'http://hello.w0r1d.net/',
gender: 'm',
country: 'AR',
message: 'Hello World!',
rank: 'User',
}
Returns a list of users ordered by followers in a determined period
Returns a list of users ordered by a score based in the last week followers
Returns a list of channels administrated by the user
get /user/{username}/c/administrated
get /user/{username}/applications
URI Parameters
- username: required (string)
Query Parameters
- sort: (string)
- after: (string)
- before: (string)
- count: (integer)
- summary: (boolean)
- page: (integer)
- nsfw: (boolean)
- q: (string)
HTTP status code 200
Body
Type: application/json
Example:
{
after: 'rm23gsa',
before: 'rm23gsa',
count: 1,
totalCount: 1,
items: [
{
id: 'rm23gsa',
created: '2016-05-27T17:07:16.000Z',
name: 'The Best Application',
type: 'application:summary'
}
]
}
post /user/{username}/report
URI Parameters
- username: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"reason": { "type": "string" },
"subReason": { "type": "string" },
"message": { "type": "string", "maxLength": 1024 }
},
"required": ["reason"],
"additionalProperties": false
}
HTTP status code 201
Returns a list of user objects that the authenticating user is blocking.
Checks if the username is available
get /user/{username}/available
Checks if the username is available
URI Parameters
- username: required (string)
Query Parameters
- accessToken: (string)
Checks if the account is local in order to perform deletion
get /user/delete/check
Checks if the account is local in order to perform deletion
Hard delete user profile/account (unaccesible)
post /user/hard-delete
Delete user profile/account
post /user/delete-social
Activate user profile/account
post /user/activate
Activate user profile/account
Delete all user stories, comments or channels
Returns a list of username suggestions
post /user/username/suggestions
Returns a list of username suggestions
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"firstname": { "type": "string" },
"lastname": { "type": "string" },
"username": { "type": "string" },
"count": { "type": "number" }
},
"additionalProperties": false
}
post /user/change-password
gets last filters selected from the user
post /user/last-state
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"is-hamburguer-open": { "type": "boolean"},
"last-nav-profile": { "type": "string", "enum": ["feed", "quests", "activity", "drafts","comments", "saved", "settings"]},
"home-story-type": {"type":"string", "enum": ["post", "shout"]},
"home-story-feed": {"type":"string", "enum": ["recent", "relevant"]},
"communities-filter": {"type":"string", "enum": ["posts", "shouts"]},
"communities-sort": {"type":"string", "enum": ["recent", "hot", "top"]},
"communities-view": {"type":"string", "enum": ["expanded", "compact"]},
"mi-filter": {"type":"string", "enum": ["posts", "shouts"]},
"mi-sort": {"type":"string", "enum": ["recent", "hot", "top"]},
"mi-view": {"type":"string", "enum": ["expanded", "compact"]},
"tops-type": {"type":"string", "enum": ["relevant", "posts", "shouts", "users", "communities", "comments"]},
"tops-time": {"type":"string", "enum": ["today", "yesterday", "week"]},
"profile-story-type": {"type":"string", "enum": ["post", "shout"]},
"activity-type": {"type":"string", "enum": ["all", "quest", "transaction", "community"]},
"activity-time": {"type":"string", "enum": ["week", "month", "year"]},
"story-comments-time": {"type":"string", "enum": ["recent", "old"]},
"widget-mis-tops-type": {"type":"string", "enum": ["post", "shout"]},
"widget-mis-tops-time": {"type":"string", "enum": ["week", "month", "year", "all"]},
"tops-post-time": {"type":"string", "enum": ["week", "month", "year", "all"]},
"tops-shout-time": {"type":"string", "enum": ["week", "month", "year", "all"]}
},
"additionalProperties": false
}
HTTP status code 200
/account
post /account/phone/patch
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"username": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"area": {
"type": "string",
"minLength": 2,
"maxLength": 4
},
"number": {
"type": "string",
"minLength": 6,
"maxLength": 15
}
}
}
},
"additionalProperties": false
}
post /account/set-phone
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"code": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"area": {
"type": "string",
"minLength": 2,
"maxLength": 4
},
"number": {
"type": "string",
"minLength": 6,
"maxLength": 15
}
}
}
},
"additionalProperties": false
}
post /account/send-sms
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"phone": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"area": {
"type": "string",
"minLength": 2,
"maxLength": 4
},
"number": {
"type": "string",
"minLength": 6,
"maxLength": 15
}
}
}
},
"additionalProperties": false
}
HTTP status code 200
post /account/email/patch
post /account/reset-password/phone
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"code": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"area": {
"type": "string",
"minLength": 2,
"maxLength": 4
},
"number": {
"type": "string",
"minLength": 6,
"maxLength": 15
}
}
}
},
"additionalProperties": false
}
HTTP status code 200
post /account/reset-password
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"newUi": {
"type": "boolean"
},
"captcha": { "type": "string" }
},
"required": ["id", "captcha"],
"additionalProperties": false
}
HTTP status code 200
post /account/change-password
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 6
},
"hash": {
"type": "string",
"minLength": 3,
"maxLength": 1024
},
"captcha": { "type": "string" }
},
"additionalProperties": false
}
HTTP status code 200
post /account/migration/{userId}
URI Parameters
- userId: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"email": { "type": "string" },
"twitter": { "type": "string" },
"facebook": { "type": "string" },
"google": { "type": "string" }
},
"additionalProperties": false
}
/session
get /session/about
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'session',
id: 'kja91',
created: '2016-05-27T17:07:16.000Z',
application: {
id: 'rm23gsa',
created: '2016-05-27T17:07:16.000Z',
name: 'The Best Application',
type: 'application:summary'
},
ip: '127.0.0.1',
country: 'ar',
userAgent: 'Chrome/54.0.2840.98',
lastAccess: '2016-05-27T18:07:16.000Z',
active: true
}
get /session/{id}/about
URI Parameters
- id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
type: 'session',
id: 'kja91',
created: '2016-05-27T17:07:16.000Z',
application: {
id: 'rm23gsa',
created: '2016-05-27T17:07:16.000Z',
name: 'The Best Application',
type: 'application:summary'
},
ip: '127.0.0.1',
country: 'ar',
userAgent: 'Chrome/54.0.2840.98',
lastAccess: '2016-05-27T18:07:16.000Z',
active: true
}
get /session/list
HTTP status code 200
Body
Type: application/json
Example:
[
{
type: 'session',
id: 'kja91',
created: '2016-05-27T17:07:16.000Z',
application: {
id: 'rm23gsa',
created: '2016-05-27T17:07:16.000Z',
name: 'The Best Application',
type: 'application:summary'
},
ip: '127.0.0.1',
country: 'ar',
userAgent: 'Chrome/54.0.2840.98',
lastAccess: '2016-05-27T18:07:16.000Z',
active: true
}
]
Returns an array of the user sessions
get /session/{username}/list
Returns an array of the user sessions
URI Parameters
- username: required (string)
HTTP status code 200
Body
Type: application/json
Example:
[
{
type: 'session',
id: 'kja91',
created: '2016-05-27T17:07:16.000Z',
application: {
id: 'rm23gsa',
created: '2016-05-27T17:07:16.000Z',
name: 'The Best Application',
type: 'application:summary'
},
ip: '127.0.0.1',
country: 'ar',
userAgent: 'Chrome/54.0.2840.98',
lastAccess: '2016-05-27T18:07:16.000Z',
active: true
}
]
Delete all user sessions
Delete user session by id
/story
post /story/bulk
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"stories": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"required": ["stories"],
"additionalProperties": false
}
HTTP status code 200
post /story/{id}/mod-delete
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"reason": { "type": "string" },
"subReason": { "type": "string" },
"message": { "type": "string", "maxLength": 1024 }
},
"additionalProperties": false
}
HTTP status code 200
post /story/{id}/patch
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": { "type": "string", "maxLength": 70 },
"channelName": { "type": "string", "maxLength": 70 },
"nsfw": { "type": "boolean" },
"author": { "type": "boolean" },
"globalUnsafe": { "type": "boolean" },
"thumbnail": { "type": "string", "maxLength": 255 },
"usertags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 3,
"maxLength": 70
}
},
"sources": {
"type": "array",
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 8
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"type": { "enum": ["markdown"] },
"body": { "type": "string" }
},
"required": ["type", "body"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"url": { "type": "string", "minLength": 8 }
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"share": {
"type": "object",
"properties": {
"type": { "enum": ["story"] },
"id": { "type": "string", "maxLength": 20 }
},
"required": ["type", "id"],
"additionalProperties": false
}
},
"required": ["type", "share"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["image"] },
"url": { "type": "string", "minLength": 8 },
"caption": { "type": "string", "maxLength": 150 },
"isThumbnail": { "type": "boolean" },
"expanded": { "type": "boolean" }
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["divider"] }
},
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
HTTP status code 200
post /story/inertia/{id}/patch
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"definitions": {
"listItem": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/listItem"
}
}
},
"required": ["items", "content"]
},
"file": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"ext": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": ["url", "width", "height"],
"additionalProperties": false
},
"embed": {
"type": "object",
"properties": {
"service": {
"type": "string"
},
"source": {
"type": "string"
},
"embed": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"caption": {
"type": "string"
}
},
"required": ["service", "source", "embed", "width", "height"],
"additionalProperties": false
},
"link-taringa": {
"type": "object",
"properties": {
"type": {
"enum": ["taringa"]
},
"storyId": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": ["type", "storyId", "url"],
"additionalProperties": false
},
"link-embed": {
"type": "object",
"properties": {
"type": {
"enum": ["embed"]
},
"service": {
"type": "string"
},
"source": {
"type": "string"
},
"embed": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"caption": {
"type": "string"
}
},
"required": ["type", "service", "source", "embed", "width", "height"],
"additionalProperties": false
},
"link-other": {
"type": "object",
"properties": {
"type": {
"enum": ["other"]
},
"link": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"image": {
"$ref": "#/definitions/file"
}
},
"required": ["title", "description"]
}
},
"required": ["type", "link", "meta"],
"additionalProperties": false
}
},
"native-tools": {
"paragraphTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["paragraph"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"headerTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["headerTool"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"level": {
"type": "number",
"enum": [2, 3, 4]
}
},
"required": ["text", "level"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"imageTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["imageTool"]
},
"data": {
"type": "object",
"properties": {
"withBorder": {
"type": "boolean"
},
"withBackground": {
"type": "boolean"
},
"stretched": {
"type": "boolean"
},
"caption": {
"type": "string"
},
"file": {
"$ref": "#/definitions/file"
}
},
"required": [
"file",
"withBorder",
"withBackground",
"stretched",
"caption"
]
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"linkTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["linkTool"]
},
"data": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/link-taringa"
},
{
"$ref": "#/definitions/link-embed"
},
{
"$ref": "#/definitions/link-other"
}
]
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"quoteTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["quoteTool"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"caption": {
"type": "string"
},
"alignment": {
"type": "string",
"enum": ["left", "center"]
}
},
"required": ["text", "caption", "alignment"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"listTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["listTool"]
},
"data": {
"type": "object",
"properties": {
"style": {
"type": "string",
"enum": ["ordered", "unordered"]
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/listItem"
}
}
},
"required": ["style", "items"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"codeTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["codeTool"]
},
"data": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": ["code"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"tableTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["tableTool"]
},
"data": {
"type": "object",
"properties": {
"content": {
"type": "array",
"contains": {
"type": "array",
"contains": {
"type": "string"
}
}
}
},
"required": ["content"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"rawTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["rawTool"]
},
"data": {
"type": "object",
"properties": {
"html": {
"type": "string"
}
},
"required": ["html"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
}
},
"custom-definitions": {
"recipeStep": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"time": {
"type": "string"
},
"file": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/file"
},
{
"$ref": "#/definitions/embed"
}
]
}
},
"required": ["description", "file"],
"additionalProperties": false
}
},
"custom-tools": {
"paragraphWithImageTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["paragraphWithImageTool"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"file": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/file"
},
{
"$ref": "#/definitions/embed"
}
]
}
},
"required": ["text", "file"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"galleryTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["galleryTool"]
},
"data": {
"type": "object",
"properties": {
"files": {
"type": "array",
"maxItems": 10,
"items": {
"$ref": "#/definitions/file"
}
}
},
"required": ["files"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"pollTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["pollTool"]
},
"data": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"answerOptions": {
"type": "array",
"contains": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"description": {
"type": "string"
}
},
"required": ["description"],
"additionalProperties": true
}
},
"id": {
"type": "number"
}
},
"required": ["question", "answerOptions"],
"additionalProperties": true
}
},
"required": ["id", "type", "data"],
"additionalProperties": true
},
"reviewerTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["reviewerTool"]
},
"data": {
"type": "object",
"properties": {
"good": {
"type": "array",
"items": {
"type": "string"
}
},
"bad": {
"type": "array",
"items": {
"type": "string"
}
},
"score": {
"type": "number",
"minimum": 0,
"maximum": 10
}
},
"required": ["score"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"recipeTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["recipeTool"]
},
"data": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"ingredients": {
"type": "array",
"items": {
"type": "string"
}
},
"difficulty": {
"type": "number"
},
"time": {
"type": "string"
},
"files": {
"type": "array",
"maxItems": 4,
"items": {
"$ref": "#/definitions/file"
}
}
},
"required": [
"description",
"ingredients",
"files"
],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"recipeStepTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["recipeStepTool"]
},
"data": {
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"$ref": "#/custom-definitions/recipeStep"
}
}
},
"required": ["steps"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
}
},
"properties": {
"title": {
"type": "string",
"maxLength": 70
},
"nsfw": {
"type": "boolean"
},
"author": {
"type": "boolean"
},
"bot": {
"type": "boolean"
},
"thumbnail": {
"type": "string",
"maxLength": 255
},
"usertags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 3,
"maxLength": 70
}
},
"sources": {
"type": "array",
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 8
}
},
"tags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"enum": ["meme"]
}
},
"data": {
"type": "object",
"required": ["time", "blocks"],
"properties": {
"time": {
"type": "number"
},
"version": {
"type": "string",
"enum": ["2.22.2", "2.22.3", "2.24.2"]
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/native-tools/paragraphTool"
},
{
"$ref": "#/native-tools/headerTool"
},
{
"$ref": "#/native-tools/imageTool"
},
{
"$ref": "#/native-tools/linkTool"
},
{
"$ref": "#/native-tools/quoteTool"
},
{
"$ref": "#/native-tools/listTool"
},
{
"$ref": "#/native-tools/codeTool"
},
{
"$ref": "#/native-tools/tableTool"
},
{
"$ref": "#/native-tools/rawTool"
},
{
"$ref": "#/custom-tools/paragraphWithImageTool"
},
{
"$ref": "#/custom-tools/galleryTool"
},
{
"$ref": "#/custom-tools/reviewerTool"
},
{
"$ref": "#/custom-tools/recipeTool"
},
{
"$ref": "#/custom-tools/recipeStepTool"
},
{
"$ref": "#/custom-tools/pollTool"
}
]
}
}
},
"challenge": {
"type": "string"
}
}
},
"required": ["title", "data"],
"additionalProperties": false
}
HTTP status code 200
post /story/{id}/report
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"reason": { "type": "string" },
"subReason": { "type": "string" },
"message": { "type": "string", "maxLength": 1024 }
},
"required": ["reason"],
"additionalProperties": false
}
HTTP status code 201
post /story/draft/{id}/patch
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": { "type": "string", "maxLength": 70 },
"channelName": { "type": "string", "maxLength": 70 },
"nsfw": { "type": "boolean" },
"usertags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"enum": ["meme"]
}
},
"sources": {
"type": "array",
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"type": { "enum": ["markdown"] },
"body": { "type": "string" }
},
"required": ["type", "body"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"url": { "type": "string", "minLength": 8 }
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"share": {
"type": "object",
"properties": {
"type": { "enum": ["story"] },
"id": { "type": "string", "maxLength": 20 }
},
"required": ["type", "id"],
"additionalProperties": false
}
},
"required": ["type", "share"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["image"] },
"url": { "type": "string", "minLength": 8 },
"caption": { "type": "string", "maxLength": 150 },
"isThumbnail": { "type": "boolean" },
"expanded": { "type": "boolean" }
},
"required": ["type", "url"],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
HTTP status code 200
post /story/draft/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": { "type": "string", "maxLength": 70 },
"channelName": { "type": "string", "maxLength": 70 },
"nsfw": { "type": "boolean" },
"usertags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"enum": ["meme"]
}
},
"sources": {
"type": "array",
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"type": { "enum": ["markdown"] },
"body": { "type": "string" }
},
"required": ["type", "body"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"url": { "type": "string", "minLength": 8 }
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"share": {
"type": "object",
"properties": {
"type": { "enum": ["story"] },
"id": { "type": "string", "maxLength": 20 }
},
"required": ["type", "id"],
"additionalProperties": false
}
},
"required": ["type", "share"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["image"] },
"url": { "type": "string", "minLength": 8 },
"caption": { "type": "string", "maxLength": 150 },
"isThumbnail": { "type": "boolean" },
"expanded": { "type": "boolean" }
},
"required": ["type", "url"],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
HTTP status code 201
/comment
post /comment/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"parent": {
"type": "object",
"properties": {
"type": { "enum": ["story", "comment"] },
"id": {
"type": "string",
"minlength": 1
}
},
"required": ["type", "id"],
"additionalProperties": false
},
"body": {
"type": "string"
},
"attachment": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"url": {
"type": "string",
"minLength": 8
}
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["image"] },
"url": {
"type": "string",
"minlength": 8
}
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["sticker"] },
"gamificationId": {
"type": "string"
}
},
"required": ["type", "gamificationId"],
"additionalProperties": false
}
]
}
},
"required": ["parent"],
"additionalProperties": true
}
HTTP status code 201
post /comment/{id}/mod-delete
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"storyType": { "type": "string" },
"reason": { "type": "string" },
"subReason": { "type": "string" },
"message": { "type": "string", "maxLength": 1024 }
},
"additionalProperties": false
}
HTTP status code 200
post /comment/{id}/report
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"reason": { "type": "string" },
"subReason": { "type": "string" },
"message": { "type": "string", "maxLength": 1024 }
},
"required": ["reason"],
"additionalProperties": false
}
HTTP status code 201
Set the comment as invisible
Set the comment as visible
Set the comment as NSFW
Set the comment as SFW
Sets the comment toxicity
Run hooks when a comment has been moderated
/c
Accepts the {username} request to join a restricted channel.
Accepts all the requests to join {name} restricted channel.
Rejects the {username} request to join a restricted channel, or kick the user out of the channel.
Rejects all the requests to join {name} restricted channel.
post /c/{name}/new
URI Parameters
- name: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": { "type": "string", "maxLength": 70 },
"nsfw": { "type": "boolean" },
"author": { "type": "boolean" },
"bot": { "type": "boolean" },
"thumbnail": { "type": "string", "maxLength": 255 },
"usertags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 3,
"maxLength": 70
}
},
"sources": {
"type": "array",
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 8
}
},
"tags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"enum": ["meme"]
}
},
"content": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"type": { "enum": ["markdown"] },
"body": { "type": "string" }
},
"required": ["type", "body"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"url": { "type": "string", "minLength": 8 }
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["link"] },
"share": {
"type": "object",
"properties": {
"type": { "enum": ["story"] },
"id": { "type": "string", "maxLength": 20 }
},
"required": ["type", "id"],
"additionalProperties": false
}
},
"required": ["type", "share"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["image"] },
"url": { "type": "string", "minLength": 8 },
"caption": { "type": "string", "maxLength": 150 },
"isThumbnail": { "type": "boolean" },
"expanded": { "type": "boolean" }
},
"required": ["type", "url"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": { "enum": ["divider"] }
},
"additionalProperties": false
}
]
}
},
"challenge": { "type": "string" }
},
"required": ["title", "content"],
"additionalProperties": false
}
HTTP status code 201
post /c/{name}/story
URI Parameters
- name: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"definitions": {
"listItem": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/listItem"
}
}
},
"required": ["items", "content"]
},
"file": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"ext": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": ["url", "width", "height"],
"additionalProperties": false
},
"embed": {
"type": "object",
"properties": {
"service": {
"type": "string"
},
"source": {
"type": "string"
},
"embed": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"caption": {
"type": "string"
}
},
"required": ["service", "source", "embed", "width", "height"],
"additionalProperties": false
},
"link-taringa": {
"type": "object",
"properties": {
"type": {
"enum": ["taringa"]
},
"storyId": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": ["type", "storyId", "url"],
"additionalProperties": false
},
"link-embed": {
"type": "object",
"properties": {
"type": {
"enum": ["embed"]
},
"service": {
"type": "string"
},
"source": {
"type": "string"
},
"embed": {
"type": "string"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"caption": {
"type": "string"
}
},
"required": ["type", "service", "source", "embed", "width", "height"],
"additionalProperties": false
},
"link-other": {
"type": "object",
"properties": {
"type": {
"enum": ["other"]
},
"link": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"image": {
"$ref": "#/definitions/file"
}
},
"required": ["title", "description"]
}
},
"required": ["type", "link", "meta"],
"additionalProperties": false
}
},
"native-tools": {
"paragraphTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["paragraph"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": ["text"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"headerTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["headerTool"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"level": {
"type": "number",
"enum": [2, 3, 4]
}
},
"required": ["text", "level"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"imageTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["imageTool"]
},
"data": {
"type": "object",
"properties": {
"withBorder": {
"type": "boolean"
},
"withBackground": {
"type": "boolean"
},
"stretched": {
"type": "boolean"
},
"caption": {
"type": "string"
},
"file": {
"$ref": "#/definitions/file"
}
},
"required": [
"file",
"withBorder",
"withBackground",
"stretched",
"caption"
]
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"linkTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["linkTool"]
},
"data": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/link-taringa"
},
{
"$ref": "#/definitions/link-embed"
},
{
"$ref": "#/definitions/link-other"
}
]
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"quoteTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["quoteTool"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"caption": {
"type": "string"
},
"alignment": {
"type": "string",
"enum": ["left", "center"]
}
},
"required": ["text", "caption", "alignment"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"listTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["listTool"]
},
"data": {
"type": "object",
"properties": {
"style": {
"type": "string",
"enum": ["ordered", "unordered"]
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/listItem"
}
}
},
"required": ["style", "items"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"codeTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["codeTool"]
},
"data": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
},
"required": ["code"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"tableTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["tableTool"]
},
"data": {
"type": "object",
"properties": {
"content": {
"type": "array",
"contains": {
"type": "array",
"contains": {
"type": "string"
}
}
}
},
"required": ["content"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"rawTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["rawTool"]
},
"data": {
"type": "object",
"properties": {
"html": {
"type": "string"
}
},
"required": ["html"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
}
},
"custom-definitions": {
"recipeStep": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"time": {
"type": "string"
},
"file": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/file"
},
{
"$ref": "#/definitions/embed"
}
]
}
},
"required": ["description", "file"],
"additionalProperties": false
}
},
"custom-tools": {
"paragraphWithImageTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["paragraphWithImageTool"]
},
"data": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"file": {
"type": "object",
"oneOf": [
{
"$ref": "#/definitions/file"
},
{
"$ref": "#/definitions/embed"
}
]
}
},
"required": ["text", "file"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"galleryTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["galleryTool"]
},
"data": {
"type": "object",
"properties": {
"files": {
"type": "array",
"maxItems": 10,
"items": {
"$ref": "#/definitions/file"
}
}
},
"required": ["files"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"pollTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["pollTool"]
},
"data": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"answerOptions": {
"type": "array",
"contains": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"description": {
"type": "string"
}
},
"required": ["description"],
"additionalProperties": true
}
},
"id": {
"type": "number"
}
},
"required": ["question", "answerOptions"],
"additionalProperties": true
}
},
"required": ["id", "type", "data"],
"additionalProperties": true
},
"reviewerTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["reviewerTool"]
},
"data": {
"type": "object",
"properties": {
"good": {
"type": "array",
"items": {
"type": "string"
}
},
"bad": {
"type": "array",
"items": {
"type": "string"
}
},
"score": {
"type": "number",
"minimum": 0,
"maximum": 10
}
},
"required": ["score"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"recipeTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["recipeTool"]
},
"data": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"ingredients": {
"type": "array",
"items": {
"type": "string"
}
},
"difficulty": {
"type": "number"
},
"time": {
"type": "string"
},
"files": {
"type": "array",
"maxItems": 4,
"items": {
"$ref": "#/definitions/file"
}
}
},
"required": [
"description",
"ingredients",
"files"
],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
},
"recipeStepTool": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": ["recipeStepTool"]
},
"data": {
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"$ref": "#/custom-definitions/recipeStep"
}
}
},
"required": ["steps"],
"additionalProperties": false
}
},
"required": ["id", "type", "data"],
"additionalProperties": false
}
},
"properties": {
"title": {
"type": "string",
"maxLength": 70
},
"nsfw": {
"type": "boolean"
},
"author": {
"type": "boolean"
},
"bot": {
"type": "boolean"
},
"thumbnail": {
"type": "string",
"maxLength": 255
},
"usertags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 3,
"maxLength": 70
}
},
"sources": {
"type": "array",
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 8
}
},
"tags": {
"type": "array",
"uniqueItems": true,
"maxItems": 10,
"items": {
"type": "string",
"enum": ["meme"]
}
},
"data": {
"type": "object",
"required": ["time", "blocks"],
"properties": {
"time": {
"type": "number"
},
"version": {
"type": "string",
"enum": ["2.22.2", "2.22.3", "2.24.2"]
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/native-tools/paragraphTool"
},
{
"$ref": "#/native-tools/headerTool"
},
{
"$ref": "#/native-tools/imageTool"
},
{
"$ref": "#/native-tools/linkTool"
},
{
"$ref": "#/native-tools/quoteTool"
},
{
"$ref": "#/native-tools/listTool"
},
{
"$ref": "#/native-tools/codeTool"
},
{
"$ref": "#/native-tools/tableTool"
},
{
"$ref": "#/native-tools/rawTool"
},
{
"$ref": "#/custom-tools/paragraphWithImageTool"
},
{
"$ref": "#/custom-tools/galleryTool"
},
{
"$ref": "#/custom-tools/reviewerTool"
},
{
"$ref": "#/custom-tools/recipeTool"
},
{
"$ref": "#/custom-tools/recipeStepTool"
},
{
"$ref": "#/custom-tools/pollTool"
}
]
}
}
},
"challenge": {
"type": "string"
}
}
},
"required": ["title", "data"],
"additionalProperties": false
}
HTTP status code 201
post /c/{name}/patch
URI Parameters
- name: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"title": { "type": "string" },
"thumbnail": { "type": "string" },
"channelType": { "type": "string", "enum": ["public", "restricted"] },
"publishingRules": {
"type": "object",
"properties": {
"story": { "type": "string", "enum": ["PR_ALL", "PR_MEMBERS_ONLY", "PR_ADMINS_ONLY"] },
"comment": { "type": "string", "enum": ["PR_COMMENT_ALL", "PR_COMMENT_MEMBERS_ONLY", "PR_COMMENT_ADMINS_ONLY"] }
}
},
"background": { "type": "string" },
"description": { "type": "string" },
"rules": { "type": "string" },
"rulesContent": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"type": { "enum": ["markdown"] },
"body": { "type": "string" }
},
"required": ["type", "body"],
"additionalProperties": false
}
]
}
},
"category": { "type": "string" },
"nsfw": { "type": "boolean" }
},
"additionalProperties": false
}
HTTP status code 200
post /c/{name}/report
URI Parameters
- name: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"reason": { "type": "string" },
"subReason": { "type": "string" },
"message": { "type": "string", "maxLength": 1024 }
},
"required": ["reason"],
"additionalProperties": false
}
HTTP status code 201
Assign a role to a user. The user must be a member of the channel.
post /c/{name}/roles/assign
Assign a role to a user. The user must be a member of the channel.
URI Parameters
- name: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"required": true,
"properties": {
"username": {
"type": "string",
"required": true
},
"role": {
"type": { "enum": ["moderator", "editor", "administrator"] },
"required": true
}
}
}
Example:
{
"user": "manolo",
"role": "moderator"
}
HTTP status code 200
Removes the role of the user. The user must be a member of the channel.
post /c/{name}/roles/remove
Removes the role of the user. The user must be a member of the channel.
URI Parameters
- name: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"required": true,
"properties": {
"username": {
"type": "string",
"required": true
}
}
}
Example:
{
"user": "manolo"
}
HTTP status code 200
post /c/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"title": { "type": "string" },
"thumbnail": { "type": "string" },
"background": { "type": "string" },
"description": { "type": "string" },
"rules": { "type": "string" },
"channelType": { "type": "string", "enum": ["public", "restricted"] },
"publishingRules": {
"type": "object",
"properties": {
"story": { "type": "string", "enum": ["PR_ALL", "PR_MEMBERS_ONLY", "PR_ADMINS_ONLY"] },
"comment": { "type": "string", "enum": ["PR_COMMENT_ALL", "PR_COMMENT_MEMBERS_ONLY", "PR_COMMENT_ADMINS_ONLY"] }
}
},
"nsfw": { "type": "boolean" },
"category": { "type": "string" }
},
"required": [
"name",
"thumbnail",
"description"
],
"additionalProperties": false
}
HTTP status code 201
Returns a list of channels ordered by activity in a determined period
Returns a list of channels ordered by subscriptions in a determined period
Returns a list of channels ordered by a score based in the last week subscriptions
Returns a list of channels ordered by a score based in the last week activity
Returns a list of channels ordered by creation date
Returns a list of channels suggested based on the query. The channels you follow have higher priority
post /c/{name}/stickies/add
post /c/{name}/stickies/delete
Move a list of stories to this channel
post /c/{name}/change-owner
/feed
get /feed/
Query Parameters
- filter: (string)
- sort: (string)
- after: (string)
- before: (string)
- count: (integer)
- summary: (boolean)
- page: (integer)
- nsfw: (boolean)
- globalSafe: (boolean)
- withTips: (boolean)
- from: (one of followed-and-subscribed-channels, followed, followed-profile, followed-profile-and-subscribed-channels, followed-profile-and-common-subscribed-channels, subscribed-channels)
- sharedBy: (boolean)
HTTP status code 200
get /feed/global
get /feed/tops/channels
Query Parameters
- period: required (one of today, yesterday, week, month, year)
- after: (string)
- before: (string)
- count: (integer)
- summary: (boolean)
- page: (integer)
- nsfw: (boolean)
- type: required (one of new-stories, new-users, visits)
get /feed/tops/posts
Query Parameters
- period: required (one of today, yesterday, week, month, year)
- after: (string)
- before: (string)
- count: (integer)
- summary: (boolean)
- page: (integer)
- nsfw: (boolean)
- type: required (one of visits, upvotes, comments, reshouts)
- sharedBy: (boolean)
get /feed/tops/users
Query Parameters
- period: required (one of today, yesterday, week, month, year)
- after: (string)
- before: (string)
- count: (integer)
- summary: (boolean)
- page: (integer)
- nsfw: (boolean)
- type: required (one of upvotes, comments, visits, newstories)
- complete: (boolean)
Add user state and stats
Returns the names of all the custom lists
Returns a feed created using channels and users on the selected list
get /feed/list/{name}
Returns items on the list of a given type
Create, reset and delete a list
Add or remove elements of {type} to the list
Remove story from sticky feed (only moderators)
Add story to the sticky feed (only moderators)
/extract
Extract metadata information from an URL.
Extract metadata information from an URL (Inertia).
/embed
Get instagram embed.
/image
Import image from url
upload image from base64 encoded file
/device
Alias to /register, for backwards compatibility
post /device/add
Alias to /register, for backwards compatibility
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"subscription": {
"type": "object",
"properties": {
"endpoint": { "type": "string", "minLength": 1 },
"token": { "type": "string", "minLength": 1 },
"keys": {
"type": "object",
"properties": {
"auth": { "type": "string", "minLength": 1 },
"p256dh": { "type": "string", "minLength": 1 }
},
"required": ["auth", "p256dh"],
"additionalProperties": false
}
},
"additionalProperties": true
},
"device": {
"type": "object",
"properties": {
"type": { "enum": ["browser", "native"] },
"lang": { "type": "string", "minLength": 1 },
"name": { "type": "string", "minLength": 1 },
"os": { "type": "string", "minLength": 1 },
"version": { "type": "string", "minLength": 1 },
"uniqueId": { "type": "string", "minLength": 1 }
},
"required": ["type"],
"additionalProperties": false
}
},
"required": ["device", "subscription"],
"additionalProperties": false
}
HTTP status code 200
post /device/register
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"subscription": {
"type": "object",
"properties": {
"endpoint": { "type": "string", "minLength": 1 },
"token": { "type": "string", "minLength": 1 },
"keys": {
"type": "object",
"properties": {
"auth": { "type": "string", "minLength": 1 },
"p256dh": { "type": "string", "minLength": 1 }
},
"required": ["auth", "p256dh"],
"additionalProperties": false
}
},
"additionalProperties": true
},
"device": {
"type": "object",
"properties": {
"type": { "enum": ["browser", "native"] },
"lang": { "type": "string", "minLength": 1 },
"name": { "type": "string", "minLength": 1 },
"os": { "type": "string", "minLength": 1 },
"version": { "type": "string", "minLength": 1 },
"uniqueId": { "type": "string", "minLength": 1 }
},
"required": ["type"],
"additionalProperties": false
}
},
"required": ["device", "subscription"],
"additionalProperties": false
}
HTTP status code 200
post /device/delete
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"subscription": {
"type": "object",
"properties": {
"endpoint": { "type": "string", "minLength": 1 },
"token": { "type": "string", "minLength": 1 },
"keys": {
"type": "object",
"properties": {
"auth": { "type": "string", "minLength": 1 },
"p256dh": { "type": "string", "minLength": 1 }
},
"required": ["auth", "p256dh"],
"additionalProperties": false
}
},
"additionalProperties": true
},
"device": {
"type": "object",
"properties": {
"type": { "enum": ["browser", "native"] },
"lang": { "type": "string", "minLength": 1 },
"name": { "type": "string", "minLength": 1 },
"os": { "type": "string", "minLength": 1 },
"version": { "type": "string", "minLength": 1 },
"uniqueId": { "type": "string", "minLength": 1 }
},
"required": ["type"],
"additionalProperties": false
}
},
"required": ["device"],
"additionalProperties": false
}
HTTP status code 200
/application
get /application/{id}/about
post /application/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"name": { "type": "string" },
"callbackUri": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["name", "callbackUri"],
"additionalProperties": false
}
post /application/{id}/patch
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"name": { "type": "string" },
"callbackUri": {
"type": "array",
"items": { "type": "string" }
}
},
"additionalProperties": false
}
HTTP status code 200
Body
Type: application/json
Example:
{
id: 'rm23gsa',
created: '2016-05-27T17:07:16.000Z',
name: 'The Best Application',
type: 'application',
callbackUri: [
'https://example.com/callback',
'https://example.net/other/callback'
]
}
/search
/video
/orphan
post /orphan/complaint-form
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 3,
"maxLength": 60
},
"url": {
"type": "string",
"minLength": 3,
"maxLength": 250
},
"email": {
"type": "string",
"minLength": 3,
"maxLength": 250
},
"text": {
"type": "string",
"minLength": 3,
"maxLength": 1024
},
"reason": { "type": "string" },
"captcha": { "type": "string" }
},
"additionalProperties": false
}
HTTP status code 201
/chat
Create a chat room
post /chat/room/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"type": { "type": "string", "enum": ["private"] },
"members": {
"type": "array",
"uniqueItems": true,
"maxItems": 1,
"items": {
"type": "string",
"minLength": 3,
"maxLength": 70
}
}
},
"required": ["members", "type"],
"additionalProperties": false
}
HTTP status code 200
fetch a chat room
post /chat/broadcast
Query Parameters
- callback: (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"message": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"attachment": {
"type": "string"
}
}
},
"members": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"required": [
"members",
"message"
],
"additionalProperties": false
}
HTTP status code 200
Send a message to chat room
post /chat/room/{roomId}/send
URI Parameters
- roomId: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"body": {
"type": "string"
},
"attachment": {
"type": "string"
}
},
"required": ["body"],
"additionalProperties": false
}
HTTP status code 200
Flag message as read
accept chat invitation
ignore chat invitation
Delete users conversation
Delete user chat messages
post /chat/user/{username}/delete
URI Parameters
- username: required (string)
HTTP status code 200
Body
Type: application/json
Example:
[
[
"prune-invitations-given",
{
"n": 11,
"nModified": 2,
"ok": 1
}
],
[
"prune-invitations-received",
{
"n": 11,
"nModified": 2,
"ok": 1
}
],
[
"prune-ignores-given",
{
"n": 11,
"nModified": 1,
"ok": 1
}
],
[
"prune-ignores-received",
{
"n": 11,
"nModified": 2,
"ok": 1
}
],
[
"mark-rooms",
{
"n": 4,
"nModified": 4,
"ok": 1
}
],
[
"blank-messages",
{
"n": 2,
"nModified": 2,
"ok": 1
}
],
[
"mark-user",
"ok",
],
"ok"
]
/rewards
Returns the balance if the user has a wallet, null otherwise
Private | Returns the balance if the user has a wallet, null otherwise
Returns the user profile including balance and current wallet
get /rewards/profile
HTTP status code 200
Body
Type: application/json
Example:
{
id: '1s6',
created: '2019-08-21T19:25:33.565Z',
type: 'user',
tid: 29061915,
username: 'JeffersonLic',
firstname: 'Jefferson',
lastname: 'Licet',
birthday: '1970-01-01',
avatar: 'https://a20.t26.net/taringa/avatares/8/B/F/A/3/9/JeffersonLic/120x120_413.jpg',
background: null,
site: '',
gender: 'm',
country: 'AR',
message: '',
wallpaper: '',
wallpaperMode: 'cover',
verified: false,
deletedByUser: false,
subscribedToDefaultChannels: true,
stories: 93,
followers: 1,
following: 1,
rank: 'Moderator',
latestStory: '2020-05-07T13:58:34.450Z',
comments: 20,
balance: '60',
email: '[email protected]',
suscriptions: 5,
alternateEmail: '[email protected]',
wallet: {
address: '0xf364098B2CD17900a0675c2F9B6f8936baD70F4f',
guard: 'taringa',
balance: '60'
}
}
Returns user activities
get /rewards/activities
Query Parameters
- page: (integer)
Page number
- count: (integer)
Number of items to fetch
- from: required (string)
Filters activities by source (me|others)
Example:
me
- eventType: (string)
Filters activities by event type
Example:
story-visit
- start: required (string)
Starting date to begin fetching activities, ISO 8601 format
- end: required (string)
Ending date to stop fetching activities, ISO 8601 format
- order: (string)
Sorting by creation date. ASC, DESC
Example:
DESC
HTTP status code 200
Body
Type: application/json
Example:
{
"count": 4,
"page": 0,
"items": [
{
"sourceUser": {
"username": "JeffersonLic",
"id": "1s6"
},
"targetUser": {
"username": "cirkronos",
"id": "1hjc"
},
"id": 49,
"eventType": "story-voted",
"targetObjectType": "story",
"targetObjectId": "1hjj",
"createdAt": "2020-05-07T14:00:03.000Z"
},
{
"sourceUser": {
"username": "JeffersonLic",
"id": "1s6"
},
"targetUser": {
"username": "cirkronos",
"id": "1hjc"
},
"id": 50,
"eventType": "story-voted",
"targetObjectType": "story",
"targetObjectId": "1hjj",
"createdAt": "2020-05-07T14:00:04.000Z"
},
{
"sourceUser": {
"username": "JeffersonLic",
"id": "1s6"
},
"targetUser": {
"username": "cirkronos",
"id": "1hjc"
},
"id": 51,
"eventType": "story-visit",
"targetObjectType": "story",
"targetObjectId": "1hjj",
"createdAt": "2020-05-07T14:00:06.000Z"
},
{
"sourceUser": {
"username": "JeffersonLic",
"id": "1s6"
},
"targetUser": {
"username": "cirkronos",
"id": "1hjc"
},
"id": 52,
"eventType": "comment-created",
"targetObjectType": "story",
"targetObjectId": "1hjj",
"createdAt": "2020-05-07T14:00:10.000Z"
}
]
}
Private | Returns all stats
get /rewards/stats/all
Query Parameters
- start: required (string)
Starting date to begin fetching activities, ISO 8601 format
- end: required (string)
Ending date to stop fetching activities, ISO 8601 format
- order: (string)
Sorting by creation date. ASC, DESC
Example:
DESC
HTTP status code 200
Body
Type: application/json
Example:
{
"items": [
{
"userId": "2",
"given": {
"story-visit": 7
},
"received": {
"story-voted": 1
},
"fixed": {
"external-milestone-completed": "10"
}
},
{
"userId": "202",
"given": {},
"received": {
"story-visit": 2,
"story-voted": 1
},
"fixed": {}
},
{
"userId": "210",
"given": {},
"received": {
"story-visit": 1
},
"fixed": {}
}
]
}
Returns the user stats
get /rewards/stats
Query Parameters
- from: required (string)
Filters activities by source (me|others)
Example:
me
- start: required (string)
Starting date to begin fetching activities, ISO 8601 format
- end: required (string)
Ending date to stop fetching activities, ISO 8601 format
HTTP status code 200
Body
Type: application/json
Example:
{
"items": {
"comment-created": 1,
"story-visit": 1,
"story-voted": 2
},
"all": {
"comment-created": 1,
"story-visit": 1,
"story-voted": 2
}
}
Returns the user transactions
get /rewards/transactions
Query Parameters
- page: (integer)
Page number
- count: (integer)
Number of items to fetch
- type: (string)
Filters transactions type (all|payment|spend)
- start: required (string)
Starting date to begin fetching activities, ISO 8601 format
- end: required (string)
Ending date to stop fetching activities, ISO 8601 format
- order: (string)
Sorting by creation date. ASC, DESC
Example:
DESC
HTTP status code 200
Body
Type: application/json
Example:
{
"count": 2,
"page": 0,
"items": [
{
"transactionType": "payment",
"amount": "200",
"createdAt": "2020-05-13T17:51:29.000Z",
"startDate": "2010-09-11",
"endDate": "2011-09-11"
},
{
"transactionType": "spend",
"amount": "200",
"createdAt": "2020-05-13T17:51:29.000Z",
"metadata": {},
"status": "successful"
}
]
}
Returns transactions summary
get /rewards/transactions/summary
Private | Register a collection of payments
post /rewards/payments/register
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"userId": {
"type": "string"
},
"hash": {
"type": "string"
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"total": {
"type": "string"
},
"items": {
"type": "array"
}
},
"required": ["userId", "startDate", "endDate", "total", "items"],
"additionalProperties": false
}
}
Example:
[
{
"userId": 1,
"startDate": "2020-04-01",
"endDate": "2020-04-30",
"total": 60,
"items": [
{
"eventType": "story-visit",
"amount": 40
},
{
"eventType": "story-created",
"amount": 20
}
]
}
]
Starts a new transaction
post /rewards/transaction/create
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"address": {
"type": "string"
},
"amount": {
"type": "string"
},
"metadata": {
"type": "object"
}
},
"required": ["address", "amount"],
"additionalProperties": false
}
Example:
{
"address": "0x1234535363636353",
"amount": "50",
"metadata": { "discountID": "1" },
}
HTTP status code 200
Body
Type: application/json
Example:
{
value: '50',
data: '0xa9059cbb0000000000000000000000002fd84f022f94b23ef3a203a86e3090084ed0d56c00000000000000000000000000000000000000000000000000005af3107a4000',
nonce: 71,
gasPrice: '118480000',
gas: 38154,
chainId: 31,
transactionId: 1
}
Execute a signed transaction
post /rewards/transaction/send
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"hash": {
"type": "string"
},
"transactionId": {
"type": "number"
}
},
"required": ["hash", "transactionId"],
"additionalProperties": false
}
Example:
{
"address": "0x1234535363636353",
"amount": "50",
"metadata": { "discountID": "1" },
}
Private | Add user to the program
Private | Remove user from the program
Create a wallet
post /rewards/wallet
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"address": {
"type": "string"
}
},
"required": ["address"],
"additionalProperties": false
}
Example:
{
"address": "0x1234535363636353",
}
HTTP status code 200
Body
Type: application/json
Example:
{
"balance": '0',
"address": '0x1234535363636353',
}
Private | Assign a wallet to a user
Private | Register a custom event
post /rewards/event/register
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": ["id", "username"],
"additionalProperties": false
},
"amount": {
"type": "string"
},
"created": {
"type": "string"
},
"challengeId": {
"type": "string"
},
"metadata": {
"type": "object"
}
},
"required": ["user", "amount", "challengeId"],
"additionalProperties": false
}
Example:
{
"user": {
id: "1",
username: "foo",
},
"amount": "100",
"challengeId": "2",
"metadata": {},
}
Private | Fetch pool allocation
/gamification
Private | Create a quest
Moderator | Return all quest
post /gamification/quest
Private | Create a quest
Body
Type: application/json
Schema:
{
"type": "object",
"definitions": {
"Task": {
"type": "object",
"properties": {
"completed": {
"type": "string"
},
"type": {
"type": "string"
},
"path": {
"type": "string"
},
"event": {
"type": "string"
},
"rules": {
"oneOf":[
{
"type": "null"
},
{
"$ref": "#/definitions/IRootRules"
}
]
},
"target": {
"type": "number"
},
"trackProgression": {
"type": "boolean"
}
},
"required": [
"type",
"event",
"target"
],
"additionalProperties": false
},
"Rewards": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"RuleOrCondition": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"rule": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"operator": {
"enum": [
"lessThan",
"greaterThan",
"equal"
]
},
"value": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"required": [
"rule"
],
"additionalProperties": false
},
{
"$ref": "#/definitions/IRootRules"
}
]
},
"IRootRules": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"some": {
"type": "array",
"items": {
"$ref": "#/definitions/RuleOrCondition"
}
}
},
"required": [
"some"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"every": {
"type": "array",
"items": {
"$ref": "#/definitions/RuleOrCondition"
}
}
},
"required": [
"every"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"every": {
"type": "array",
"items": {
"$ref": "#/definitions/RuleOrCondition"
}
},
"some": {
"type": "array",
"items": {
"$ref": "#/definitions/RuleOrCondition"
}
}
},
"required": [
"every",
"some"
],
"additionalProperties": false
}
]
}
},
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": {
"type": "string",
"maxLength": 140
},
"i18n_title": {
"type": "string",
"maxLength": 140
},
"description": {
"type": "string"
},
"i18n_description": {
"type": "string"
},
"bonus_description": {
"type": "string"
},
"i18n_bonus_description": {
"type": "string"
},
"instructions": {
"type": "string"
},
"i18n_instructions": {
"type": "string"
},
"cover": {
"type": "string",
"maxLength": 255
},
"bonusRules": {
"$ref": "#/definitions/IRootRules"
},
"periodicity": {
"enum": [
"daily",
"weekly",
"one-time"
]
},
"level": {
"enum": [
"SPECIALIZED",
"ADVANCED",
"EXPERT",
"LEGENDARY",
"MYTHICAL",
"NO_LEVEL"
]
},
"rewards": {
"type": "array",
"items": {
"$ref": "#/definitions/Rewards"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/definitions/Task"
}
},
"bonus": {
"type": "array",
"items": {
"$ref": "#/definitions/Rewards"
}
},
"auto": {
"type": "boolean",
"default": false
},
"active": {
"type": "boolean",
"default": true
},
"target": {
"type": "number",
"default": 0
},
"createdAt": {
"type": "string"
},
"category": {
"type": "string"
},
"questNtfLang": {
"type": "object"
}
},
"required": [
"title",
"i18n_title",
"description",
"i18n_description",
"rewards",
"tasks"
],
"additionalProperties": false
}
HTTP status code 200
Moderator | Return quest details
Moderator | Delete a quest
Moderator | Publish a quest
Moderator | Assign quest identified with questId
Moderator | Assign random quest
post /gamification/quest/campaign/create
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"campaignTitle": { "type": "string" },
"campaignDescription": { "type": "string" },
"campaignNotificationText": { "type": "string" },
"reward": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rewardType": {
"type": "string",
"enum": [
"silver",
"item",
"medal"
]
},
"rewardValue": { "type": "number" }
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
HTTP status code 200
post /gamification/quest/campaign/assign
Hard Deletes the user (unaccesible)
Private | Return the current user with gamification system details
get /gamification/user/mod/quest/{questId}/{username}
URI Parameters
- questId: required (number)
- username: required (string)
Private | Return all quest for the current user
Private | Return quest progression for the current user
Private | Accept quest identified with questId for the current user
Private | Decline quest identified with questId for the current user
Private | Redeem quest identified with questId for the current user
Private | delete quest identified with questId for the current user
Moderator | Add user to the beta of gamification system
Moderator | Remove user from the beta of gamification system
Moderator | Add experience to user
Moderator | Add coins to user
Moderator | Add coins to user with user migrate
Moderator | Migrate user to gamification system
Private | Return user activity
Return user One Time Quests
Fetch all user classic medals
Equip selected item
Drop equipped item
Fetch all user items
Fetch user items
post /gamification/tip/fetch/multi
post /gamification/tip/story
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"storyId": { "type": "string", "maxLength": 70 },
"amount": { "type": "number" },
"currencyType": { "type": "string", "enum": ["silver"] }
},
"required": ["storyId", "amount", "currencyType"],
"additionalProperties": false
}
/gifs
/authentication
post /authentication/user/signup/local
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"country": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"newsletter": {
"type": "boolean"
},
"subdomain": {
"type": "string",
"enum": [
"alpha",
"isolated"
]
}
},
"required": [
"username",
"email",
"password"
],
"additionalProperties": false
}
HTTP status code 201
post /authentication/user/signup/facebook
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"firstname": { "type": "string" },
"id": { "type": "string" },
"lastname": { "type": "string" },
"country": { "type": "string" },
"email": { "type": "string" },
"birthday": { "type": "string" },
"picture": { "type": "string" },
"gender": { "type": "string" },
"newsletter": { "type": "boolean"}
},
"required": ["username"],
"additionalProperties": false
}
HTTP status code 201
post /authentication/user/signup/google
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"firstname": { "type": "string" },
"id": { "type": "string" },
"lastname": { "type": "string" },
"country": { "type": "string" },
"email": { "type": "string" },
"picture": { "type": "string" },
"newsletter": { "type": "boolean"}
},
"required": ["username", "email"],
"additionalProperties": false
}
HTTP status code 201
/trends
post /trends/new
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"channelName": {
"type": "string"
}
},
"required": [
"title",
"url",
"channelName"
],
"additionalProperties": false
}
HTTP status code 201
/tus
post /tus/webhook
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"Upload": {
"type": "object",
"properties": {
"MetaData": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": ["token"]
}
},
"required": ["MetaData"]
}
},
"required": ["Upload"],
"additionalProperties": true
}
HTTP status code 200
/stats
/shop
get /shop/shopping/stock
Query Parameters
- page: (number - default: 1)
- limit: (number - default: 20)
- objectType: (string)
- setType: (string)
- assetType: (string)
- assetCategory: (string)
- couponVendor: (number)
- onlyNft: (boolean)
- omitId: (number)
- nftCategories: (string)
- sort: (string)
- sortBy: (string)
- random: (boolean)
- assetFilterType: (string)
- status: (string)
HTTP status code 200
get /shop/shopping/users/inventory/type/{type}
Hard Deletes the user (unaccesible)
/inertia/story
List creator templates
post /inertia/story/templates
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": { "type": "string", "maxLength": 70 },
"content": { "type": "string", "maxLength": 8000 },
"iconLight": { "type": "string", "maxLength": 255 },
"iconLightHover": { "type": "string", "maxLength": 255 },
"iconDark": { "type": "string", "maxLength": 255 },
"iconDarkHover": { "type": "string", "maxLength": 255 },
"label": { "type": "string", "maxLength": 64 }
},
"required": ["content", "label", "iconLight", "iconLightHover", "iconDark", "iconDarkHover"],
"additionalProperties": false
}
HTTP status code 201
Get template details
Update template
post /inertia/story/templates/{templateId}/
Update template
URI Parameters
- templateId: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"title": { "type": "string", "maxLength": 70 },
"content": { "type": "string", "maxLength": 8000 },
"iconLight": { "type": "string", "maxLength": 255 },
"iconLightHover": { "type": "string", "maxLength": 255 },
"iconDark": { "type": "string", "maxLength": 255 },
"iconDarkHover": { "type": "string", "maxLength": 255 },
"label": { "type": "string", "maxLength": 64 }
},
"required": ["content", "label", "iconLight", "iconLightHover", "iconDark", "iconDarkHover"],
"additionalProperties": false
}
HTTP status code 200
Delete template
Change template access to be public
Change template access to only moderators
Vote a poll
set an image as nsfw
set an image as sfw
get /inertia/story/images/search/{type}
URI Parameters
- type: required (string)
Query Parameters
- username: (string)
- categories: (string)
- query: (string)
- page: (number)
- sort: (string)
get /inertia/story/images/list
Query Parameters
- categories: (string)
- page: (number)
move image between collections
post /inertia/story/images/collection/move
move image between collections
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"collectionSrc": { "type": "string" },
"collectionDst": { "type": "string" },
"url": { "type": "string" }
},
"additionalProperties": false
}
HTTP status code 200
remove image from collection
post /inertia/story/images/collection/delete
add image to collection
post /inertia/story/images/collection/add
get /inertia/story/images/tag
Query Parameters
- url: required (string)
add tag to image
delete tag to image
post /inertia/story/images/tag/delete
List all drafts from an user
create a draft for specific user
post /inertia/story/drafts
create a draft for specific user
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"id": { "type": ["string", "null"] },
"title": { "type": "string", "maxLength": 70 },
"content": { "type": "array", "items": {
"type": "object",
"properties": {
"id": { "type": ["string", "null"] },
"data": { "type": "object" }
},
"additionalProperties": true
}},
"nsfw": { "type": "boolean" },
"author": { "type": "boolean" },
"thumbnail": { "type": ["string", "null"] },
"target": { "type": "string" },
"tags": { "type": "array", "items": { "type": "string" }},
"sources": { "type": "array", "items": { "type": "string" }},
"channelId": { "type": ["string", "null"] },
"storyId": { "type": ["string", "null"] }
},
"required": ["content", "title"],
"additionalProperties": false
}
HTTP status code 201
get a draft by id
update a draft by id
delete a draft by id
get a draft by story id