Introduction
Welcome to the Aku API documentation. Learn how to integrate and leverage the power of Aku in your PropTech applications.
What is Aku?
Aku (悪) is an open-source, modular AI framework built specifically for real estate and PropTech. It provides a plug-and-play system of prompts, agents, assistants, tools, context modules, and workflows that make implementing AI in real estate applications simple and effective.
Whether you're building property management software, market analysis tools, or customer service solutions, Aku provides the building blocks you need to create powerful AI-driven features.
Key Features
Purpose-built for real estate use cases with specialized agents and workflows.
Mix and match prompts, agents, assistants, and tools to create custom AI solutions.
Works with OpenAI, Anthropic, local models, and more. Switch providers without changing your implementation.
Built-in safeguards prevent catastrophic actions, ensuring your AI systems operate within defined parameters.
Getting Started
The easiest way to get started with Aku is to install the SDK for your preferred language:
npm install @aku/sdkThen, import and initialize the SDK:
import { Aku } from '@aku/sdk';
// Initialize the client with your API key
const aku = new Aku({
apiKey: 'your_api_key',
});
// Create a simple property description agent
const agent = aku.agents.create('property-description', {
model: 'gpt-4', // or 'anthropic/claude-3' or 'local/llama-3'
});
// Generate a property description
const description = await agent.generate({
property: {
type: 'apartment',
bedrooms: 2,
bathrooms: 1,
sqft: 1200,
features: ['hardwood floors', 'updated kitchen', 'balcony'],
neighborhood: 'downtown',
city: 'Seattle',
state: 'WA',
}
});
console.log(description);