StreamVi
HomeDocumentation
HomeDocumentation
  1. HelpPage
  • Method v1
    • PlanRestream
      • Get tariff for project
      • Remove after tariff
      • Buy restream tariff
      • Get list of restream tariffs
      • Get list of restream tariffs for project
      • Get discount restream
      • Load data for show card the tariffs v2
    • MoneyFlow
      • Transaction list for frontend
    • Project
      • Select user for project
      • Get project by number id
      • Get user by number id
      • List of user in project
      • Remove user from project
      • Change access user from project
      • List of project for current user
      • Get project full info
    • ProjectHistory
      • Get project history of actions
    • NotifyUser
      • Delete mobile token from user
      • Get user notify settings
      • Set user notify settings
      • Get user screen notify
      • Remove user screen notify
    • Centrifuge
      • Auth centrifuge
      • Auth token for project
      • Auth token for broadcast
    • Stream key
      • Get stream credentials
      • Update record
    • PlanTranscoding
      • Get tariff for project
      • Remove after tariff
      • Buy transcoder tariff
      • Get list of transcoding tariffs
      • Get discount transcoding
      • Check transcoding tariff before buy
    • PlanStorage
      • Get tariff for project
      • Remove next tariff
      • Buy storage tariff
      • Get info for storage tariff
      • Get discount of storage
      • Check storage tariff before buy
    • Channel settings
      • Optional settings for vk. Depends on the tariff.
      • Optional settings for youtube. Depends on the tariff.
      • Optional settings for trovo. Depends on the tariff.
      • Optional settings for twitch. Depends on the tariff.
      • Optional settings for ok. Depends on the tariff.
      • Optional settings for vk video live. Depends on the tariff.
      • Set planned id. Depends on the tariff.
      • Get playlists from the platform
      • Get planned list
      • Set name from custom channel. Global settings.
      • Set rtmp url from channel. Global settings.
      • Set transcoder from channel. Personal settings.
      • Get status platform
      • Get status platform
      • Optional settings for telegram
      • Get telegram post by filter
      • Get telegram post list
      • Get telegram settings
      • Set telegram settings
      • Get code for connected chat
      • Disconnect telegram chat
    • Channel
      • Search channel list
      • Minimal channel list
      • Get live status
    • Transcoders
      • List of transcoder
      • Transcoder create
      • Transcoder update
      • Transcoder delete
      • Transcoder stop
    • Platforms
      • Get url for start oauth
      • Get category from the platform
      • Get category from the platform
      • Supported platforms
    • Auth
      • Connect telegram in account
      • Get url for start oauth
      • Connected social account
      • Internal request of auth old vk
      • Internal request of auth new vk
      • Internal request of auth google
      • Disconnected social account
      • CallBack for connect social
      • Get code for auth
      • Code exchange
    • Socials
      • Social list for user
    • Transactions
      • Transaction list for frontend
    • BlogPage
      • Get list of blog pages
      • Get blog page
    • HelpPage
      • Get list of help pages
        GET
      • Get help page
        GET
      • Get structure of help pages
        GET
    • NotifyHistory
      • Get my NotifyHistory item by id
      • Get list of my notifications
      • Get my status unread message for user
      • Set all notification in cabinet as read
      • Run action in my notify item
      • Set notification in cabinet as read
    • ProjectChannelInvite
      • List of invites for channel in project
      • Get invitation for channel
      • Accept channel invitation for selected project
      • Decline channel invitation for selected project
      • Get channel invitation using a secret link
      • Accept channel invitation using a secret link
      • Decline channel invitation using a secret link
      • Get channel invite item for my channel for another user
      • Add channel invite item for another user by id
      • Add channel invite item for another user by email
      • Del channel invite item for my channel for another user
    • ProjectChannel
      • Project channel list
      • Remove access for project in channel
      • Change access for project in channel
      • Transfer owner for project in channel
    • BlogPageTag
      • Get list of blog pages
    • RtmpServer
      • Rtmp locations server list example for unauthorized
      • List rtmp servers
      • State of rtmp servers
      • State of rtmp servers
      • Graph of rtmp servers
    • Pay system
      • Load available pay systems
      • PaySystemController_createChallenge[1]
      • PaySystemController_createUnitpay[1]
    • Payment
      • Create payment item for pay system
      • PaymentController_getStatus[1]
      • PaymentController_list[1]
    • Pay setting
      • Get pay settings for profile v3
      • Set pay settings for profile
      • Check country after update user
    • Stream pull keys
      • Check key
      • List keys
      • Create key
      • Update key
      • Delete key
    • Payout
      • Create payout
      • Get payout data for create
    • Chat gateway
      • List history message
      • Send message
      • Get one message
      • Remove message
    • Broadcast
      • Connect channel, long polling
      • Get restreams
    • Release
      • Get current version app
    • Live
      • View live info
    • Analytics
      • Bitrate for stream
      • Viewers for stream
      • Events for stream
    • Promo
      • Check code
      • Apply code
    • PolicyPage
      • Get policy page
      • Get policy structure
    • Referrals
      • Total info
    • Pull servers
      • Get pull servers
    • Users
      • Get user profile
      • Update profile
    • Account
      • Get account profile
      • Update account profile
  1. HelpPage

Get structure of help pages

GET
/method/help/page/structure
HelpPage

Request

Authorization
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the oauth.
Example:
Authorization: oauth ********************
Query Params
v
enum<string> 
required
Version
Allowed values:
123
Example:
3
language
enum<string> 
required
Current language
Allowed values:
ruencn
Default:
en
Example:
en

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-v2.streamvi.io/method/help/page/structure?v&language'

Responses

🟢200OK
application/json
Body
success
boolean 
required
Response execution success
Default:
true
result
array[object (StructureHelpPageItemResponse) {10}] 
required
Structure of help page
_id
object 
required
notion_id
string 
required
Notion id
notion_parent_id
string 
required
Notion parent id
url
string 
required
url
url_inherit
string 
required
Generated url from root path
status
enum<string> 
required
Page status
Allowed values:
NoneBacklogDraftingReviewingDonePublished
Default:
Backlog
title
array[object (StructureHelpPageConnectionsItemLang) {3}] 
required
Subject
icon
null  | allOf {1} 
required
Page icon
priority
number 
required
Priority for sorting
connections
array[object (StructureHelpPageItemResponse2) {10}] 
required
Structure of child pages same as this array of class StructureHelpPageItemResponse, maximum 4
Example
{
    "success": true,
    "result": [
        {
            "_id": {
                "type": {}
            },
            "notion_id": "string",
            "notion_parent_id": "string",
            "url": "string",
            "url_inherit": "string",
            "status": "Backlog",
            "title": [
                {
                    "language": "russian",
                    "language_iso": "ru",
                    "value": "string"
                }
            ],
            "icon": {},
            "priority": 0,
            "connections": [
                {
                    "_id": {
                        "type": {}
                    },
                    "notion_id": "string",
                    "notion_parent_id": "string",
                    "url": "string",
                    "url_inherit": "string",
                    "status": "Backlog",
                    "title": [
                        {
                            "language": "russian",
                            "language_iso": "ru",
                            "value": "string"
                        }
                    ],
                    "icon": {},
                    "priority": 0,
                    "connections": [
                        {
                            "_id": {
                                "type": {}
                            },
                            "notion_id": "string",
                            "notion_parent_id": "string",
                            "url": "string",
                            "url_inherit": "string",
                            "status": "Backlog",
                            "title": [
                                {
                                    "language": "russian",
                                    "language_iso": "ru",
                                    "value": "string"
                                }
                            ],
                            "icon": {},
                            "priority": 0,
                            "connections": [
                                {
                                    "_id": {
                                        "type": {}
                                    },
                                    "notion_id": "string",
                                    "notion_parent_id": "string",
                                    "url": "string",
                                    "url_inherit": "string",
                                    "status": "Backlog",
                                    "title": [
                                        {
                                            "language": "russian",
                                            "language_iso": "ru",
                                            "value": "string"
                                        }
                                    ],
                                    "icon": {},
                                    "priority": 0
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
🟠400Bad Request
Modified at 2025-06-14 12:31:21
Previous
Get help page
Next
Get my NotifyHistory item by id
Built with