Skip to main content

Quickstart

Deploy your first AI agent in 5 minutes. By the end of this guide, you'll have a working agent that can answer questions about your organization.

Prerequisites​

  • A Deeployd account (create one)
  • Access to the Dashboard

Step 1: Create an Agent​

  1. From the Dashboard, click + Create Agent
  2. Fill in the basics:
FieldValueWhy
Name"Company FAQ Assistant"How users will identify this agent
Description"Answers common questions about our company"Helps you remember what this agent does
ModelClaude 3.5 SonnetBest balance of speed and capability
  1. Click Create

Step 2: Write the System Prompt​

The system prompt tells your agent who it is and how to behave. In the agent editor, enter:

You are a helpful FAQ assistant for Acme Corporation.

Your responsibilities:
- Answer common questions about our company
- Provide accurate information from our knowledge base
- Escalate complex questions to human support

Our key information:
- Founded: 2020
- Headquarters: San Francisco, CA
- Employees: 150
- Products: AI-powered workflow automation

Communication style:
- Be friendly and professional
- Keep answers concise (2-3 sentences when possible)
- If you don't know something, say so

Step 3: Add Tools (Optional)​

Tools give your agent capabilities beyond conversation. For this quickstart, we'll skip tools, but you could add:

  • Memory - Remember facts from conversations
  • HTTP Request - Fetch live data from APIs
  • Calculator - Perform calculations

Step 4: Test Your Agent​

  1. Click Test in the agent editor
  2. The chat panel opens on the right
  3. Try these test messages:
User: What does your company do?
Agent: Acme Corporation provides AI-powered workflow automation
       solutions. We help businesses automate repetitive tasks
       and improve operational efficiency.

User: How many employees do you have?
Agent: We currently have 150 employees at Acme Corporation.

User: Can I speak to someone about enterprise pricing?
Agent: I'd be happy to connect you with our sales team for
       enterprise pricing inquiries. Would you like me to
       escalate this request to a human representative?

Step 5: Deploy​

Your agent is now ready to use! Here's how to access it:

In the Dashboard​

  • Go to Agents → Click your agent → Chat
  • Use this for testing and internal use

Via API​

curl -X POST https://api.deeployd.com/v1/agents/{agent_id}/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "What does your company do?"
  }'

Embed in Your App​

import { DeepLoyd } from '@deeployd/sdk';

const client = new DeepLoyd({ apiKey: 'YOUR_API_KEY' });

const response = await client.agents.chat({
  agentId: 'your-agent-id',
  message: 'What does your company do?'
});

console.log(response.content);

What You've Built​

Congratulations! You've created an AI agent that:

  • ✅ Has a defined personality and knowledge
  • ✅ Can answer questions about your organization
  • ✅ Knows when to escalate to humans
  • ✅ Is accessible via API

What's Next?​

Make It Smarter​

Organize Your Workspace​

Automate​

Connect​

Advanced Features (Pro+)​

  • Studio - Advanced template creation suite for AI engineers
  • Security Center - Centralized security management (Business+)

Built something cool? Share it on Discord!