Introduction
Quick Start
Get up and running with Yachtsy Agent in under 2 minutes. This guide will walk you through creating your API key and making your first request to access specialized sailing expertise.
Whether you're building a yacht brokerage platform, sailing education app, or marine services website, you'll have expert sailing knowledge integrated into your application in just a few simple steps.
1. Get an API Key
Get your free API key in 30 seconds:
- Sign up at yachtsy.ai/signup
- Menu → API Keys → Create New
- Copy and store securely
2. Make Your First Call
Expert sailing advice with any OpenAI-compatible SDK:
from openai import OpenAI
client = OpenAI(
api_key="your-yachtsy-api-key",
base_url="https://api.yachtsy.ai/v1"
)
# Generate detailed sailboat listing descriptions
response = client.chat.completions.create(
model="yachtsy-agent",
messages=[{
"role": "system",
"content": "You are a yacht broker creating compelling listing descriptions that highlight key selling points and technical specifications."
}, {
"role": "user",
"content": "Create a detailed listing description for a 2007 Catalina 385 with 450 engine hours, new sails in 2023, asking $165k. Include key features and selling points."
}]
)
# Extract the listing description
listing = response.choices[0].message.content
print("YACHT LISTING:")
print(listing)
# Example output:
# YACHT LISTING:
# **2007 Catalina 385 - Turn-Key Cruiser Ready for Adventure**
#
# **Price: $165,000** | **LOA: 38'6"** | **Beam: 12'11"** | **Draft: 5'7"**
#
# This well-maintained Catalina 385 represents exceptional value for serious cruisers...
import OpenAI from 'openai';
const client = new OpenAI({
// Note: Replace with your API key or use environment variables
apiKey: process.env.YACHTSY_API_KEY,
baseURL: 'https://api.yachtsy.ai/v1'
});
// Make the API call for sailing advice
const response = await client.chat.completions.create({
model: 'yachtsy-agent',
messages: [
{
role: 'system',
content: 'You are a sailing expert specializing in yacht recommendations and sailing techniques.'
},
{
role: 'user',
content: 'What are the key differences between a sloop and a ketch rig? Which is better for single-handed sailing?'
}
]
});
// Extract the sailing advice
const advice = response.choices[0].message.content;
console.log('SAILING EXPERT ADVICE:');
console.log(advice);
curl -X POST https://api.yachtsy.ai/v1/chat/completions \
-H "Authorization: Bearer your-yachtsy-api-key" \
-H "Content-Type: application/json" \
-d '{
"model": "yachtsy-agent",
"messages": [
{
"role": "system",
"content": "You are a marine weather expert and passage planning specialist."
},
{
"role": "user",
"content": "Plan a sailing route from Fort Lauderdale to Nassau in December. What weather patterns should I watch for?"
}
]
}'
That's it! You now have access to specialized sailing expertise through a familiar OpenAI-compatible interface. The Yachtsy Agent automatically routes your questions to the most appropriate specialized model, whether you need yacht specifications, navigation advice, or market insights.
What makes this different? Unlike general AI models, Yachtsy Agent is specifically trained on sailing and yacht data, providing accurate, detailed responses that understand the nuances of maritime terminology, boat specifications, and sailing conditions.
Ready for production? The API is designed for real-world applications - yacht brokerages use it for listing descriptions, sailing schools for educational content, and charter companies for trip planning. All responses are structured and reliable enough for customer-facing applications.
Key Features
Comprehensive sailing expertise through a familiar API:
- 🔄 OpenAI‑Compatible: Drop-in replacement - just change the base URL
- ⚡ Streaming Support: Real-time responses with Server-Sent Events
- 🧠 Specialized Knowledge: Expert sailing, navigation, and yacht information
- 🔗 Multiple Endpoints: Chat completions, models, and legacy compatibility
- 🔑 Simple Auth: Easy API key management through web UI
- 📊 Usage Tracking: Built-in token counting and system fingerprinting
Next Steps
- Authentication - Secure API key setup
- Usage Overview - Model selection guide
- Yachtsy Models - Explore specialized sailing agents
- API Reference - Complete endpoint documentation
- Web Integration - Framework-specific examples
- Example Projects - Real-world applications
- Sailing Glossary - Maritime terminology reference
- Quick Reference - Fast lookup guide
Support
Need help? We're here for you:
- Email: support@yachtsy.ai
- Community: Join sailing discussions
- Quick Help: Reference guide
What You Can Ask
Expert answers for any sailing question: