API Reference

Athena AIAPI Documentation

Integrate Athena's conversational AI, agent management, and growth insights into your applications with our comprehensive REST API and WebSocket connections.

REST & WebSocket

Secure authentication

Real-time updates

QuickStart Guide

Get up and running with the Athena API in just a few steps.

1. Get API Key

Generate your API key from the Athena Console dashboard

2. Make First Call

Test authentication and explore available endpoints

3. Start Conversation

Begin interacting with your Athena AI agent

Authentication Example

curl -X GET "https://api.aethyr.cloud/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

APICategories

Explore the different API categories available for Athena integration.

Agent Management

Create, configure, and manage your Athena AI agents

Conversations

Handle real-time interactions and conversation history

Insights & Analytics

Access growth metrics, patterns, and personalized insights

Account & Settings

User management, privacy controls, and platform configuration

Agent Management APIs

List AgentsGET

Retrieve all agents associated with your account

GET /v1/agents

Create AgentPOST

Create a new Athena AI agent with custom configuration

POST /v1/agents

Update AgentPUT

Update agent personality, goals, or configuration settings

PUT /v1/agents/{agent_id}

Create Agent Example

{
  "name": "Personal Athena",
  "personality": {
    "traits": ["empathetic", "encouraging", "insightful"],
    "communication_style": "conversational",
    "emotional_intelligence": "high"
  },
  "goals": {
    "primary": "personal_development",
    "focus_areas": ["self_awareness", "goal_achievement", "habit_formation"]
  },
  "voice_settings": {
    "enabled": true,
    "language": "en-US",
    "tone": "warm"
  }
}

Authentication &Security

Understand how to securely authenticate and protect your API interactions.

API Key Authentication

Secure your API calls with bearer token authentication using your unique API key.

Authorization: Bearer sk-athena-...

Rate Limiting

API calls are rate-limited to ensure fair usage and optimal performance.

• 1000 requests/hour (standard)
• 10,000 requests/hour (premium)
• WebSocket: 100 concurrent connections

Security Best Practices

• Never expose API keys in client-side code or public repositories
• Use environment variables to store sensitive credentials
• Rotate API keys regularly and monitor for unusual activity
• Implement request signing for additional security in production

SDKs &Libraries

Official SDKs and community libraries to accelerate your integration.

JavaScript/TypeScript

Official SDK for Node.js, React, and browser applications.

npm install @aethyr/athena-sdk

Python

Comprehensive Python library with async support.

pip install athena-ai-sdk

Ruby

Community-maintained Ruby gem for Rails integration.

gem install athena_ai

Don't see your preferred language?

Request SDK Support

Interactive API Explorer

Test API endpoints, explore responses, and build your integration with our interactive documentation tool.

Try the API Explorer

Interactive Swagger UI with live API testing, request/response examples, and automatic code generation in multiple languages.

Open API Explorer

Back to Quickstart Developer Support