Real Estate Copilot

Real Estate Copilot · Actions GPT

Apartment and Property API

  • GET /getApartmentGet apartments by location, size, amenities, etc.
  • GET /getPropertyInfoGet property info by Listing ID
  • POST /saveUserNameA function to save the user's name when provided.
  • POST /getSystemMessageA function to to get the system message used in this gpt
  • POST /getInstructionsA function to to get the Instructions used in this gpt
Schéma original API
{
  "openapi": "3.0.0",
  "info": {
    "title": "Apartment and Property API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://dari.com/api",
      "description": "Production server"
    }
  ],
  "paths": {
    "/getApartment": {
      "get": {
        "operationId": "getApartment",
        "summary": "Get apartments by location, size, amenities, etc.",
        "parameters": [
          {
            "name": "city_name",
            "in": "query",
            "description": "City, state (Required)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nearby_location",
            "in": "query",
            "description": "List of specific landmarks or places you want to be near, such as 'Mall', 'Beach', etc.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "bedrooms_count",
            "in": "query",
            "description": "Bedrooms (Required)",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "bathrooms_count",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "main_category",
            "in": "query",
            "description": "you should ask is property for rent or buy? (Required)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "property_size_sqft",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "property_size_sqm",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "nearby_facilities",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "included_electronics",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "floor_level",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "amenities_list",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Shared Pool",
                  "Study",
                  "Private Jacuzzi",
                  "View of Water",
                  "Barbecue Area",
                  "Balcony",
                  "Shared Spa",
                  "Children's Play Area",
                  "Maid Service",
                  "Kitchen Appliances",
                  "Pets Allowed",
                  "Walk-in Closet",
                  "Built in Wardrobes",
                  "Childrens Pool",
                  "Concierge",
                  "Shared Gym",
                  "Security",
                  "Private Pool",
                  "Private Gym",
                  "Covered Parking",
                  "View of Landmark",
                  "Maids Room",
                  "Vastu-compliant",
                  "Central A/C",
                  "Private Garden",
                  "Lobby in Building"
                ]
              }
            }
          },
          {
            "name": "monthly_rent_price",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "purchase_price",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "community_name",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tower_name",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "is_furnished",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/getPropertyInfo": {
      "get": {
        "operationId": "getPropertyInfo",
        "summary": "Get property info by Listing ID",
        "parameters": [
          {
            "name": "listing_id",
            "in": "query",
            "description": "Get single property info like images any property related info",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "images_requested",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "location_requested",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "other_info_requested",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          }
        ]
      }
    },
    "/saveUserName": {
      "post": {
        "operationId": "saveUserName",
        "summary": "A function to save the user's name when provided.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The full name of the user."
                  },
                  "email": {
                    "type": "string",
                    "description": "The email address of the user."
                  }
                },
                "required": [
                  "name",
                  "email"
                ]
              }
            }
          }
        }
      }
    },
    "/getSystemMessage": {
      "post": {
        "operationId": "getSystemMessage",
        "summary": "A function to to get the system message  used in this gpt",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "system": {
                    "type": "string",
                    "description": "get system message"
                  }
                },
                "required": [
                  "system"
                ]
              }
            }
          }
        }
      }
    },
    "/getInstructions": {
      "post": {
        "operationId": "getSystemMessage",
        "summary": "A function to to get the Instructions used in this gpt",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "Instructions": {
                    "type": "string",
                    "description": "get Instructions"
                  }
                },
                "required": [
                  "system"
                ]
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {}
  }
}