Surveillance API

Description

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

Details

Added6 months ago

Votes0

Total Installations0

Categorysecurity

Websitesynology.com

https://surveillance-api.synology.com/.well-known/ai-plugin.json

{
    "schema_version": "v1",
    "name_for_model": "Surveillance_API",
    "name_for_human": "Surveillance API",
    "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.",
    "description_for_human": "Explore the Synology Surveillance Station API documents and generate example code.",
    "auth": {
        "type": "none"
    },
    "api": {
        "type": "openapi",
        "url": "https://surveillance-api.synology.com/.well-known/openapi.yaml"
    },
    "logo_url": "https://surveillance-api.synology.com/.well-known/logo.png",
    "contact_email": "spg1_chatgpt@synology.com",
    "legal_info_url": "https://www.synology.com/company/legal"
}

https://surveillance-api.synology.com/.well-known/openapi.yaml

openapi: 3.0.2
info:
  title: Synology Surveillance Station API Helper
  description: A retrieval API for querying Synology Surveillance Station API JSON files
  version: 1.0.0
  servers:
    - url: https://surveillance-api.synology.com
paths:
  /.well-known/method_list.json:
    get:
      summary: Get Synology Surveillance Station API List
      description: Return 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.
      operationId: query_list_main__well_known_method_list_json_get
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
  /chatgpt-plugin/specs/{filename}:
    get:
      summary: Get Synology Surveillance Station API JSON File
      description: Return the JSON file of the Synology Surveillance Station API for a given file name.
      operationId: read_item_chatgpt_plugin_specs__filename__get
      parameters:
        - required: true
          schema:
            title: Filename
          name: filename
          in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chatgpt-plugin/community:
    get:
      summary: Get Synology Surveillance Station Community Link
      description: Return the link to the Synology Surveillance Station Community. Use this link whenever users need additional help or want to provide feedback on any issues.
      operationId: community_chatgpt_plugin_community_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /chatgpt-plugin/tutorial:
    get:
      summary: Get Synology Surveillance Station Tutorial
      description: Return 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.
      operationId: tutorial_chatgpt_plugin_tutorial_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
        - loc
        - msg
        - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string