Getting Started with the Fastkd API

Getting Started with the Fastkd API

This tutorial will walk you through integrating Fastkd into your application. By the end, you'll be able to execute prompts, manage versions, and track usage programmatically.

Prerequisites

Before starting, ensure you have:

Step 1: Install the SDK

Install the Fastkd SDK using npm or yarn:

npm install @fastkd/sdk

# or

yarn add @fastkd/sdk

Step 2: Configure Authentication

Get your API key from the Fastkd dashboard under Settings > API Keys.

import { Fastkd } from '@fastkd/sdk';

const client = new Fastkd({

apiKey: 'your-api-key-here',

});

Step 3: Execute Your First Prompt

Let's execute a simple prompt:

async function generateProductDescription() {

const response = await client.execute({

promptId: 'product-description',

variables: {

productName: 'Smart Watch Pro',

features: ['heart rate monitor', 'GPS', 'water resistant'],

targetAudience: 'fitness enthusiasts',

},

});

console.log(response.output);

console.log(`Tokens used: ${response.usage.totalTokens}`);

}

Step 4: Working with Versions

Fastkd supports versioning for all prompts:

// Get the latest version

const latest = await client.prompts.get('product-description');

// Get a specific version

const v2 = await client.prompts.get('product-description', { version: 2 });

// List all versions

const versions = await client.prompts.listVersions('product-description');

Step 5: Streaming Responses

For long-form content, use streaming to improve user experience:

const stream = await client.execute({

promptId: 'blog-post-generator',

variables: { topic: 'AI in Healthcare' },

stream: true,

});

for await (const chunk of stream) {

process.stdout.write(chunk.content);

}

Step 6: Error Handling

Implement proper error handling:

import { FastkdError, RateLimitError } from '@fastkd/sdk';

try {

const response = await client.execute({ promptId: 'my-prompt' });

} catch (error) {

if (error instanceof RateLimitError) {

console.log(`Rate limited. Retry after ${error.retryAfter}s`);

} else if (error instanceof FastkdError) {

console.error(`API Error: ${error.message}`);

} else {

throw error;

}

}

Step 7: Webhooks (Optional)

Set up webhooks to receive notifications:

// In your webhook handler

app.post('/webhooks/fastkd', (req, res) => {

const event = req.body;

switch (event.type) {

case 'prompt.executed':

console.log(`Prompt executed: ${event.data.promptId}`);

break;

case 'prompt.updated':

console.log(`Prompt updated: ${event.data.promptId}`);

break;

}

res.status(200).send('OK');

});

Best Practices

1. **Store API keys securely** - Never commit keys to version control

2. **Implement retries** - Handle transient failures gracefully

3. **Monitor usage** - Track token consumption to manage costs

4. **Use caching** - Cache responses when appropriate

5. **Test thoroughly** - Use our sandbox environment for testing

Next Steps

Now that you're up and running, explore:

Have questions? Join our Discord community or contact support.