# API Reference

    # Taker

    Space Takeris a space image analysis API that integrates powerful deep learning model with easy-to-use REST API.
    Input image can be classified into a single space such as living room / room / kitchen / bathroom and recognize objects such as furniture and electronics within the image of the given space.
    Space Taker APIrequests HTTP communication using one or more methods (POST, PUT, GET, DELETE) that are provided for each function.
    After receiving the spatial image data, it returns the analysis result as JSON Type. The maximum size of the input image is Up to 5MB,
    and supported image formats are JPG, PNG file format.

    # Classifier

    Classifier issues a unique identification code of the requested spatial image, validates it along with the image storage path, and analyzes the following information in the image. \

    • Information about spatial classification result\
      • Classification label
      • Classification probability

    # [POST] - classifier

    • Request
      • image_path String
        (required)
        File path where image is saved
    • Response
      {
          "code": number, // Response status code of the requested result. 
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image 
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // Path to image file sent on request
                      "created_date": date, // Created date
                      "results": [ //  An array of objects containing the result of spatial classification
                                              {
                                                  "label": string, // Spatial classification result label
                                                  "probability": float // Probability of spatial classification result
                                              },
                                          ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15

    # [GET] - classifier/<uuid>/

    • Request
      • uuid String
        (required)
        Unique identifier code
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image 
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of spatial classification
                                              {
                                                  "label": string, // Spatial classification result label
                                                  "probability": float // Probability of spatial classification result
                                              },
                                          ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15

    # Detector

    Detectoranalyzes the requested spatial image and returns the following information.
    Returns an error if the UUID is invalid.

    • Result on the object detection
      • Type of detected object
      • Detection score
      • Position information of the detected object

    # [POST] - detector

    • Request
      • image_path String
        (required)
        File path where image is saved
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, //  Response status message of the requested result. 
          "data": { // Information about the requested image 
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of object detection
                                          {
                                              "label": string, // Type of detected objects
                                              "score": float, // Detection score
                                              "xmin": float, // Upper left x coordinate of the detected object area box
                                              "ymin": float, // Upper left x coordinate of the detected object area box
                                              "xmax": float, // Lower right x coordinate of the detected object area box
                                              "ymax": float // Lower right x coordinate of the detected object area box
                                          },
                                      ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19

    # [GET] - detector/<uuid>/

    • Request
      • uuid String
        (required)
        Unique identifier code
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image 
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of object detection
                                          {
                                             "label": string, // Type of detected objects
                                              "score": float, // Detection score
                                              "xmin": float, // Upper left x coordinate of the detected object area box
                                              "ymin": float, // Upper left x coordinate of the detected object area box
                                              "xmax": float, // Lower right x coordinate of the detected object area box
                                              "ymax": float // Lower right x coordinate of the detected object area box
                                          },
                                      ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19

    # Analyzer

    Analyzer analyzes the requested spatial image and returns the following information.
    Returns an error if the UUID is invalid.

    • Result on the preference analysis
      • Style Analysis label
      • Analysis probability
      • Description of the analysis style

    # [POST] - analyzer

    • Request
      • image_path String
        (required)
        File path where image is saved
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image 
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of style analysis
                                          {
                                              "label": string, // Style Analysis Result Label
                                              "probability": float, // Probability of style analysis results
                                              "description": string // Description of style analysis results
                                          }
                                      ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16

    # [GET] - analyzer/<uuid>/

    • Request
      • uuid String
        (required)
        Unique identifier code
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of style analysis
                                          {
                                              "label": string, // Style Analysis Result Label
                                              "probability": float, // Probability of style analysis results
                                              "description": string // Description of style analysis results
                                          }
                                      ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16

    # Extractor

    Extractor analyzes the requested spatial image and returns the following information.
    Returns an error if the UUID is invalid.

    • Color analysis result information
      • Extracted color RGB code
      • Extracted color proportion

    # [POST] - extractor

    • Request
      • image_path String
        (required)
        File path where image is saved
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of color extraction
                                          {
                                              "r": number, // Red decimal code in RGB color
                                              "g": number, // Green decimal code in RGB color
                                              "b": number, // Blue decimal code in RGB color
                                              "proportion": float // Proportion of that color in the image
                                          }
                                      ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17

    # [GET] - extractor/<uuid>/

    • Request
      • uuid String
        (required)
        Unique identifier code
    • Response
      {
          "code": number, // Response status code of the requested result.
          "message": string, // Response status message of the requested result. 
          "data": { // Information about the requested image
                      "space_image_uuid": string, // Unique identifier code
                      "image_path": string, // File path where image is saved
                      "created_date": date, // Created date
                      "results": [ // An array of objects containing the result of color extraction
                                          {
                                              "r": number, // Red decimal code in RGB color
                                              "g": number, // Green decimal code in RGB color
                                              "b": number, // Blue decimal code in RGB color
                                              "proportion": float // Proportion of that color in the image
                                          }
                                      ]
                  }
      }
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
    top button