# AI-Powered Property Search and Analysis

**POST /v2/PropGPT**

Use natural language queries to search for properties and get AI-powered insights and analysis.
Leverages GPT models to understand complex search requirements and provide intelligent results.



## Servers
- Production server: https://api.realestateapi.com (Production server)


## Authentication methods
- Api key


## Parameters
### Headers
- **x-api-key** (string)
  API key for authentication
- **x-user-id** (string)
  Optional user identifier for tracking and analytics
- **X-OpenAI-Key** (string)
  OpenAI API key for GPT processing (optional if configured server-side)



### Body: application/json (object)
PropGPT natural language query
- **size** (integer(int32))
  Number of results to return (maximum of 250).
- **query** (string)
  Natural language query that references data points in the Property Search API in order to retrieve a list of properties.
- **model** (string)
  GPT model to use for processing


## Responses
### 200
Successful AI-powered search response

#### Body: application/json (object)
- **input** (object)
  Echo of the input parameters
- **data** (array[object])
  Array of properties found matching the query
- **gpt_response** (object)
  GPT model analysis and explanation
- **totalResults** (integer)
  Total number of matching properties
- **returnedResults** (integer)
  Number of results returned
- **statusCode** (integer)
  HTTP status code
- **live** (boolean)
  Indicates if data is live
- **usage** (object)
  Token usage information

### 400
Bad Request - Invalid input parameters

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **statusCode** (integer)

- **details** (object)
  Additional error details

### 401
Unauthorized - Invalid or missing API key

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **statusCode** (integer)


### 500
Internal Server Error

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **statusCode** (integer)



[Powered by Bump.sh](https://bump.sh)