API Reference
CRM APIs
Lyra

Lyra API Reference

Overview

The Lyra API provides endpoints for email communication in the TKM AI Agency Platform. It handles email summaries and notifications for conversation updates.

Base URL

/email

Endpoints

Send Email Summary

POST /email/send

Sends an email with a conversation summary.

Request Body

{
    "user_id": "string",
    "organization_id": "string",
    "conversation_id": "string",
    "email_type": "string",
    "metadata": {
        "additional": "data"
    }
}

Response

{
    "success": true,
    "message_id": "string",
    "metadata": {
        "sent_at": "2024-01-20T12:00:00Z",
        "recipient": "string",
        "email_type": "string"
    }
}

Error Responses

500 Internal Server Error

{
    "detail": "Error message"
}

Integration Notes

Email Features

  • Conversation summaries
  • Notification handling
  • Template support
  • Metadata inclusion

Event System

  • Event-based processing
  • Asynchronous handling
  • Status tracking
  • Error recovery

Email Management

  • Template rendering
  • Recipient validation
  • Delivery tracking
  • Error handling

Integration with Other Agents

  • Atta: Conversation context
  • Humile: Content normalization
  • Prometheus: Summary generation
HumileOrfeo