Quick Start Guide
Get up and running with the BuildwellAI API in minutes
1. Get Your API Key
Sign up for a free account and generate your API key from the dashboard.
2. Make Your First Call
Use our SDKs or make direct HTTP requests to start accessing construction data.
3. Build & Scale
Integrate our API into your applications and scale with confidence.
Code Examples
// Initialize BuildwellAI SDK
const BuildwellAI = require('@buildwellai/sdk');
const client = new BuildwellAI({
apiKey: process.env.BUILDWELLAI_API_KEY,
environment: 'production' // or 'sandbox'
});
// Get latest construction news
async function getLatestNews() {
try {
const news = await client.news.list({
category: 'regulation',
limit: 10,
urgent_only: true
});
console.log(`Found ${news.data.total_count} articles`);
return news.data.articles;
} catch (error) {
console.error('Error fetching news:', error);
}
}API Endpoints
Comprehensive reference for all available endpoints
/api/v1/newsGet Construction News
Retrieve the latest UK construction industry news, filtered and curated by AI.
categoryFilter by category (regulation, technology, policy, safety)
limitNumber of articles to return (default: 20, max: 100)
date_fromFilter articles from this date (ISO 8601 format)
urgent_onlyReturn only urgent/breaking news
/api/v1/safety-alertsGet Safety Alerts
Retrieve critical safety alerts and building regulation updates.
severityFilter by severity (critical, high, medium, low)
regionFilter by UK region
/api/v1/compliance/checkCheck Compliance
Submit project details for AI-powered compliance checking against current UK building regulations.
project_typeType of construction project
locationProject location details
specificationsProject specifications and materials
Authentication
API Key Authentication
All API requests must include your API key in the Authorization header using Bearer token authentication.
Authorization: Bearer YOUR_API_KEYRate Limits
- • Free tier: 1,000 requests/month
- • Pro tier: 10,000 requests/month
- • Enterprise: Custom limits
Response Codes
- •
200- Success - •
400- Bad Request - •
401- Unauthorized - •
429- Rate Limited