Quick Start
Get up and running with Celeris in under 5 minutes.
This guide will walk you through creating your first Celeris agent and running it. By the end, you’ll have a working automation that responds to events.
Prerequisites
Before you begin, make sure you have:
- A Celeris account (sign up here)
- An API key (available in your dashboard)
- Node.js 18+ or Python 3.9+ installed
Installation
Install the Celeris SDK for your preferred language:
npm install @celeris/sdkCreate Your First Agent
Initialize the client
First, import and configure the Celeris client with your API key:
import { Celeris } from '@celeris/sdk';
const celeris = new Celeris({ apiKey: process.env.CELERIS_API_KEY,});Define your agent
Create an agent with a name and instructions:
const agent = await celeris.agents.create({ name: 'My First Agent', instructions: 'You are a helpful assistant that answers questions.', model: 'gpt-4',});
console.log('Agent created:', agent.id);Run the agent
Execute the agent with an input:
const response = await celeris.agents.run(agent.id, { input: 'What is the capital of France?',});
console.log('Response:', response.output);// Response: Paris is the capital of France.Full Example
Here’s the complete code:
import { Celeris } from '@celeris/sdk';
async function main() { // Initialize client const celeris = new Celeris({ apiKey: process.env.CELERIS_API_KEY, });
// Create agent const agent = await celeris.agents.create({ name: 'My First Agent', instructions: 'You are a helpful assistant that answers questions.', model: 'gpt-4', });
// Run agent const response = await celeris.agents.run(agent.id, { input: 'What is the capital of France?', });
console.log('Response:', response.output);}
main().catch(console.error); Congratulations!
You’ve created your first Celeris agent! Continue to learn about Workflows and Integrations.
Next Steps
- Learn about Workflows to chain multiple agents
- Set up Webhooks to trigger agents from external events
- Explore the API Reference for all available endpoints