Developer API Documentation
AI Content Generation API
Generate professional property listing titles and descriptions automatically using our powerful AI API
Getting Started
Authentication
All API requests require authentication using your API key in the request header.
API Key Authentication
Include your API key in the X-API-Key header of every request.
Example Header
X-API-Key: your_api_key_hereAPI Endpoint
POST
/api/AIContent/generate-contentGenerate AI-powered titles and descriptions for property listings based on uploaded images.
Base URL: https://contentapi.resideprime.com
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Images | File[] | ✓ Required | Property images (max 10, 10MB each) |
| PropertyType | Integer | ✓ Required | 0=Unknown, 1=House, 2=Apartment, 3=Condo, 4=Townhouse, 5=Duplex, 6=Studio, 7=Other |
| ListingType | Integer | ✓ Required | 0=Sale, 1=Rent, 2=Lease |
| Location | String | Optional | Property location (city) |
Response Format
Success Response (200 OK)
{
"Success": true,
"Title": "Modern 3BR House in Downtown Toronto",
"Description": "Spacious family home featuring...",
"ProcessingTime": "13247ms"
}Code Examples
Node.js (JavaScript)
example.js
const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');
const form = new FormData();
form.append('PropertyType', '1');
form.append('ListingType', '1');
form.append('Location', 'Toronto, ON');
form.append('Images', fs.createReadStream('./property.jpg'));
axios.post('https://contentapi.resideprime.com/api/AIContent/generate-content', form, {
headers: {
'X-API-Key': 'YOUR_API_KEY',
...form.getHeaders()
}
})
.then(response => {
console.log('Title:', response.data.Title);
console.log('Description:', response.data.Description);
})
.catch(error => console.error(error));Python
example.py
import requests
url = 'https://contentapi.resideprime.com/api/AIContent/generate-content'
headers = {'X-API-Key': 'YOUR_API_KEY'}
files = {'Images': open('property.jpg', 'rb')}
data = {
'PropertyType': '1',
'ListingType': '1',
'Location': 'Toronto, ON'
}
response = requests.post(url, headers=headers, files=files, data=data)
result = response.json()
print(f"Title: {result['Title']}")
print(f"Description: {result['Description']}")cURL
Terminal
curl -X POST 'https://contentapi.resideprime.com/api/AIContent/generate-content' \
-H 'X-API-Key: YOUR_API_KEY' \
-F 'PropertyType=1' \
-F 'ListingType=1' \
-F 'Location=Toronto, ON' \
-F 'Images=@property.jpg'Rate Limits
- 1,000 requests/day
Per API key on paid plans
- 1 requests/second
Maximum burst rate
Error Codes
400Bad Request - Invalid parameters401Unauthorized - Invalid API key429Too Many Requests - Rate limit exceeded500Internal Server Error - Try again later