Surveillance API

Surveillance API

Explore the Synology Surveillance Station API documents and generate example code.

Name For Model
Surveillance_API
Update Date
6 months ago
Description For Model
Search through the Synology Surveillance Station API .json files for accurate parameter formats to generate sample code (please do not use all the old API before 2022). Use it for any queries about the Synology Surveillance Station API. Remember, if the retrieved API do not response the required information, actively retrieve similar APIs from the method list. Always use HTTPS protocol and URL-encoding for URLs. Perform ThirdParty/Auth/Login&Logout operations before and after using other APIs. (Use 'passwd' instead of 'password' in login) The double-quoted-string format parameters require to include double quotes around the parameter values in URLs (use '"string"' in Golang), especially the "camId". Use '_sid' instead of 'sid' in securitySchemes and 'sid' in API response. Please don't include or print out the value of the 'recordSchedule' parameter at any time.

Plugin Functions/Features (Plugin API Document)

Operation IdHTTP MethodDescription
1query_list_main__well_known_method_list_json_getGETReturn a list of Synology Surveillance Station API methods, each with a method name, summary and file name. Use this list to identify the file names of the API methods that need to be retrieved.
2read_item_chatgpt_plugin_specs__filename__getGETReturn the JSON file of the Synology Surveillance Station API for a given file name.
3community_chatgpt_plugin_community_getGETReturn the link to the Synology Surveillance Station Community. Use this link whenever users need additional help or want to provide feedback on any issues.
4tutorial_chatgpt_plugin_tutorial_getGETReturn the tutorial for the Synology Surveillance API Plugin in markdown. Use this API when the users need guidance on how to utilize the Surveillance API plugin.