AEVON API Reference

Integrate AEVON AI agents into your applications. RESTful API, JSON responses, webhook support.

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from the Dashboard under Settings → API Keys.

Chat — Conversational AI Agent

POST /v1/chat/message Send a message to an agent
Parameters
NameTypeRequiredDescription
agent_idstringrequiredYour agent identifier
messagestringrequiredUser message text
conversation_idstringoptionalContinue existing conversation
languagestringoptionalen, fr, de, es, it (default: en)
metadataobjectoptionalCustom metadata (user info, page URL...)
Request
curl -X POST https://api.aevon.agency/v1/chat/message \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "agent_id": "agent_abc123", "message": "How do I reset my password?", "conversation_id": "conv_xyz789", "language": "en" }'
Response
{ "reply": "To reset your password, go to Settings > Security...", "conversation_id": "conv_xyz789", "confidence": 0.94, "sources": ["faq-passwords", "help-security"], "escalation_needed": false }
GET /v1/chat/conversations List conversations
Query Parameters
NameTypeDescription
agent_idstringFilter by agent
statusstringopen, resolved, escalated
limitintegerResults per page (default: 20, max: 100)
offsetintegerPagination offset
Request
curl https://api.aevon.agency/v1/chat/conversations?agent_id=agent_abc123&limit=10 \ -H "Authorization: Bearer YOUR_API_KEY"
DELETE /v1/chat/conversations/{id} Delete a conversation (GDPR)

Permanently deletes a conversation and all associated messages. This action is irreversible and designed for GDPR data deletion requests.

Request
curl -X DELETE https://api.aevon.agency/v1/chat/conversations/conv_xyz789 \ -H "Authorization: Bearer YOUR_API_KEY"

Recruit — AI CV Screening

POST /v1/recruit/screen Screen a candidate CV against job requirements
NameTypeRequiredDescription
job_descriptionstringrequiredFull job description text
cv_textstringrequiredCandidate CV/resume text
criteriaobjectoptionalCustom scoring weights
Response
{ "score": 82, "recommendation": "strong_match", "skills_matched": ["python", "django", "postgresql"], "skills_missing": ["kubernetes"], "experience_fit": "exceeds", "suggested_questions": [ "Describe your experience with container orchestration", "Tell me about a Django project you led end to end" ] }

Agents — Management

GET /v1/agents List your agents
Response
{ "agents": [ { "id": "agent_abc123", "name": "Support Agent", "type": "chat", "status": "active", "conversations_today": 89, "resolution_rate": 0.87 } ] }
PUT /v1/agents/{id}/knowledge Update agent knowledge base
NameTypeDescription
contentstringKnowledge base content (FAQ, docs, product info)
modestring"replace" or "append" (default: replace)

Analytics

GET /v1/analytics/summary Get usage and performance summary
NameTypeDescription
periodstringtoday, week, month, custom
agent_idstringFilter by agent (optional)
Response
{ "period": "week", "conversations": 847, "messages": 3291, "auto_resolved": 738, "escalated": 109, "resolution_rate": 0.87, "avg_response_time_ms": 1200, "satisfaction_score": 4.7, "top_topics": ["shipping", "returns", "pricing"] }

Webhooks

POST /v1/webhooks Register a webhook for real-time events

Receive real-time notifications when events occur (new conversation, escalation, satisfaction score).

NameTypeDescription
urlstringYour webhook endpoint URL
eventsarrayconversation.created, conversation.escalated, conversation.resolved, satisfaction.received