Skip to main content

Install

TypeScript SDK

Python SDK

Methods

TypeScript:
  • listInboxes()
  • createInbox(payload, options?)
  • updateInbox(id, payload, options?)
  • deleteInbox(id, options?)
  • sendEmail(payload, options?)
  • listEmails(params?)
  • updateEmailRead(id, isRead, options?)
  • deleteEmail(id, options?)
  • listDomains()
  • createDomain(payload, options?)
  • verifyDomain(id, options?)
  • deleteDomain(id, options?)
  • listApiKeys()
  • createApiKey(payload, options?)
  • rotateApiKey(id, options?)
  • revokeApiKey(id, options?)
  • getMetrics()
Python:
  • list_inboxes()
  • create_inbox(...)
  • update_inbox(...)
  • delete_inbox(...)
  • send_email(...)
  • list_emails(...)
  • update_email_read(...)
  • delete_email(...)
  • list_domains()
  • create_domain(...)
  • verify_domain(...)
  • delete_domain(...)
  • list_api_keys()
  • create_api_key(...)
  • rotate_api_key(...)
  • revoke_api_key(...)
  • get_metrics()

Error handling

TypeScript SDK throws EmailAgentApiError with:
  • status
  • body
Python SDK raises EmailAgentApiError with:
  • status_code
  • payload
For retriable mutations, always pass an idempotency key.