Features Pricing Quickstart API Docs Status Log In

Developer Quickstart

Get your AI agent communicating with the real world in under 5 minutes.

On this page

  1. Get Your API Key
  2. Make Your First Request
  3. Create an Agent
  4. Send a Message
  5. Rate Limits
  6. Error Handling
  7. Need Help?
1

Get Your API Key

Sign up at /app and navigate to Settings in your dashboard. Your API key will be displayed there. Copy it — you will need it for every request.

Tip: Your API key is a Bearer token. Never expose it in client-side code or public repositories.
2

Make Your First Request

Verify your API key works by calling the /v1/auth/me endpoint:

curl
curl -X GET https://api.eqhoids.com/v1/auth/me \
  -H "Authorization: Bearer YOUR_API_KEY"

You should get a JSON response with your account details:

Response
{
  "id": "usr_abc123",
  "email": "[email protected]",
  "plan": "free",
  "agents_count": 0
}
3

Create an Agent

An agent is your AI's identity. Create one with a name and description:

curl -X POST https://api.eqhoids.com/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "MyBot", "description": "Customer support agent"}'
import requests

resp = requests.post(
    "https://api.eqhoids.com/v1/agents",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "name": "MyBot",
        "description": "Customer support agent"
    }
)
print(resp.json())
const res = await fetch("https://api.eqhoids.com/v1/agents", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "MyBot",
    description: "Customer support agent"
  })
});
const data = await res.json();
console.log(data);

The response includes your new agent_id — save it for the next steps.

4

Send a Message

Send a message through your agent using the Telegram channel:

curl
curl -X POST https://api.eqhoids.com/v1/messages/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ 
    "agent_id": "YOUR_AGENT_ID",
    "channel": "telegram",
    "to": "USER_CHAT_ID",
    "content": "Hello from my AI agent!"
  }'

Supported channels: telegram, email, webhooks.

5

Rate Limits

Rate limits depend on your plan. Limits are returned in response headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset).

PlanRequests/minAgentsMessages/mo
Free51100
Starter12055,000
Pro6002550,000
BusinessCustomUnlimited500,000
6

Error Handling

All errors return a JSON body with a detail field. Common error codes:

CodeMeaningWhat to do
400Bad RequestCheck your request body and parameters
401UnauthorizedCheck your API key is valid and included
403ForbiddenYour plan does not support this action
404Not FoundThe resource (agent, message) does not exist
429Rate LimitedWait and retry after X-RateLimit-Reset
500Server ErrorRetry later; contact support if persistent

Example error response:

JSON
{
  "detail": "Invalid API key",
  "status_code": 401
}
7

Need Help?

We are here to help you build amazing things with EqhoIDs.