| name | clay-hello-world |
|---|---|
| description | Create a minimal working Clay example. Use when starting a new Clay integration, testing your setup, or learning basic Clay API patterns. Trigger with phrases like "clay hello world", "clay example", "clay quick start", "simple clay code". |
| allowed-tools | Read, Write, Edit |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <[email protected]> |
Clay Hello World
Overview
Minimal working example demonstrating core Clay functionality.
Prerequisites
- Completed
clay-install-authsetup - Valid API credentials configured
- Development environment ready
Instructions
Step 1: Create Entry File
Create a new file for your hello world example.
Step 2: Import and Initialize Client
import { ClayClient } from '@clay/sdk';
const client = new ClayClient({
apiKey: process.env.CLAY_API_KEY,
});
Step 3: Make Your First API Call
async function main() {
// Your first API call here
}
main().catch(console.error);
Output
- Working code file with Clay client initialization
- Successful API response confirming connection
- Console output showing:
Success! Your Clay connection is working.
Error Handling
| Error | Cause | Solution |
|---|---|---|
| Import Error | SDK not installed | Verify with npm list or pip show |
| Auth Error | Invalid credentials | Check environment variable is set |
| Timeout | Network issues | Increase timeout or check connectivity |
| Rate Limit | Too many requests | Wait and retry with exponential backoff |
Examples
TypeScript Example
import { ClayClient } from '@clay/sdk';
const client = new ClayClient({
apiKey: process.env.CLAY_API_KEY,
});
async function main() {
// Your first API call here
}
main().catch(console.error);
Python Example
from clay import ClayClient
client = ClayClient()
# Your first API call here
Resources
Next Steps
Proceed to clay-local-dev-loop for development workflow setup.