Getting Started with EqhoIDs in 5 Minutes
This guide takes you from zero to a working AI agent in under five minutes. By the end, you will have an agent that can send and receive messages on Telegram, all controlled through the EqhoIDs API. No prior experience with EqhoIDs is required.
What You Will Build
In this quickstart, you will set up the complete foundation for an AI-powered agent:
By the end of this guide, you will have:
- An EqhoIDs account with a live API key
- A deployed AI agent with a unique identity
- A Telegram channel connected to your agent
- Your first message sent through the agent
- Knowledge of the full platform capabilities
Everything in this guide uses the free tier. No credit card is required at any step.
Create Your Account
Head to eqhoids.com/app and sign up. You can register with your email address or connect your GitHub account for one-click authentication. The signup process takes about 30 seconds.
After you confirm your email (check your spam folder if it does not arrive within a minute), you will land on the EqhoIDs Dashboard. This is your command center for managing agents, API keys, and usage metrics.
GitHub signup recommended: If you sign up with GitHub, your account is automatically verified and you skip the email confirmation step entirely. It also makes it easier to connect repositories later if you use our CI/CD integrations.
Get Your API Key
From the Dashboard, navigate to Settings in the left sidebar, then click API Keys. Click the "Generate New Key" button. Give your key a descriptive name like "dev-testing" so you can identify it later.
Your API key will be displayed once. Copy it immediately and store it somewhere safe. You will use this key to authenticate all API requests. If you lose it, you can always generate a new one, but the old key cannot be retrieved.
# Save this in your environment variables
export EQHOIDS_API_KEY="eqho_sk_your_key_here"
Keep your key secret. Never commit API keys to version control, share them in chat messages, or include them in client-side code. Use environment variables or a secrets manager.
Create Your First Agent
Now for the exciting part. Let us create your agent. Choose your preferred language:
curl -X POST https://api.eqhoids.com/v1/agents \
-H "Authorization: Bearer $EQHOIDS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "my-first-agent",
"display_name": "My First Agent",
"description": "A test agent for the quickstart guide"
}'
import requests
import os
API_KEY = os.environ["EQHOIDS_API_KEY"]
BASE = "https://api.eqhoids.com/v1"
headers = {
"Authorization": f"Bearer {API_KEY}",
"Content-Type": "application/json"
}
response = requests.post(f"{BASE}/agents", headers=headers, json={
"name": "my-first-agent",
"display_name": "My First Agent",
"description": "A test agent for the quickstart guide"
})
agent = response.json()
print(f"Agent ID: {agent['id']}")
const API_KEY = process.env.EQHOIDS_API_KEY;
const BASE = "https://api.eqhoids.com/v1";
const response = await fetch(`${BASE}/agents`, {
method: "POST",
headers: {
"Authorization": `Bearer ${API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
name: "my-first-agent",
display_name: "My First Agent",
description: "A test agent for the quickstart guide"
})
});
const agent = await response.json();
console.log(`Agent ID: ${agent.id}`);
The response contains your agent's unique ID (something like agent_a1b2c3d4e5). Save this. You will need it for the next steps.
Connect Telegram
Your agent exists, but it has no way to communicate yet. Let us give it a Telegram channel. First, you need a Telegram bot token:
- Open Telegram and search for
@BotFather - Send the command
/newbot - Choose a name and username for your bot
- BotFather will give you a token that looks like
123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
Now connect it to your EqhoIDs agent:
curl -X POST https://api.eqhoids.com/v1/agents/AGENT_ID/channels \
-H "Authorization: Bearer $EQHOIDS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "telegram",
"config": {
"bot_token": "YOUR_TELEGRAM_BOT_TOKEN"
}
}'
AGENT_ID = "agent_a1b2c3d4e5" # from Step 3
response = requests.post(
f"{BASE}/agents/{AGENT_ID}/channels",
headers=headers,
json={
"type": "telegram",
"config": {
"bot_token": "YOUR_TELEGRAM_BOT_TOKEN"
}
}
)
channel = response.json()
print(f"Telegram connected: {channel['status']}")
const AGENT_ID = "agent_a1b2c3d4e5"; // from Step 3
const res = await fetch(
`${BASE}/agents/${AGENT_ID}/channels`,
{
method: "POST",
headers: {
"Authorization": `Bearer ${API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
type: "telegram",
config: { bot_token: "YOUR_TELEGRAM_BOT_TOKEN" }
})
}
);
const channel = await res.json();
console.log(`Telegram connected: ${channel.status}`);
EqhoIDs validates the bot token, sets up the webhook with Telegram's servers, and returns a confirmation. Your agent is now live on Telegram.
Send a Test Message
Time to make your agent speak. To get your own Telegram chat ID, start a conversation with your new bot in Telegram (search for it by the username you gave it in BotFather). Then send any message to it. Check the agent's incoming messages in the dashboard to find your chat ID, or use the @userinfobot on Telegram.
curl -X POST https://api.eqhoids.com/v1/agents/AGENT_ID/messages \
-H "Authorization: Bearer $EQHOIDS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "telegram",
"to": "YOUR_CHAT_ID",
"text": "Hello from my first EqhoIDs agent! 🤖"
}'
Check your Telegram. You should see the message from your bot. That is it. Your agent just communicated with the outside world through an API call.
Two-way communication: To receive messages from users, set a webhook_url when creating your agent (Step 3). EqhoIDs will POST incoming messages to that URL in a consistent JSON format. See the full identity tutorial for a webhook handler example.
Explore Other Services
Agent messaging is just one part of the EqhoIDs platform. Here are the other services available to you right now:
- 3D Model Conversion: Convert between GLTF, GLB, FBX, OBJ, STL, DAE, 3MF, and PLY formats via API. Free tier includes 10 conversions per month. Read our complete 3D conversion guide.
- Video Generation: Create short-form video content programmatically. Generate product showcases, social media clips, or informational videos from text descriptions and templates.
- Content Services: Generate and manage structured content for your agents. Create knowledge bases, FAQ documents, and training data that your agents can reference when responding to users.
- Multi-Channel Messaging: Beyond Telegram, connect your agent to Email. Use the same unified messaging API regardless of channel. All messages are tracked and logged in your dashboard.
All services share the same API key and the same authentication pattern. If you can call one endpoint, you can call them all.
What's Next
You have a working agent. Here is where to go from here depending on what you want to build:
- Build a support bot: Read How to Give Your AI Agent a Real Identity for a deep dive into webhook handlers, multi-channel deployment, and real-world use cases.
- Add 3D capabilities: Check out The Ultimate Guide to 3D Model Conversion APIs to add file conversion to your pipeline.
- Read the full API reference: The API Documentation covers every endpoint, parameter, error code, and rate limit in detail.
- Join the community: Connect with other developers building on EqhoIDs. Share projects, ask questions, and get help from the team.
The free tier gives you 100 messages per month and 10 3D conversions. That is enough to build, test, and validate your idea. When you are ready for production traffic, upgrade from the dashboard at any time.
Start building now
You read the guide. Now make it real. Create your free account and deploy your first agent.
Open Dashboard