agentmail 0.5.29 → 0.5.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/agent/client/Client.d.ts +32 -2
- package/dist/cjs/api/resources/agent/client/Client.js +97 -2
- package/dist/cjs/api/resources/agent/types/AgentAttachHumanRequest.d.ts +7 -0
- package/dist/cjs/api/resources/agent/types/AgentAttachHumanRequest.js +3 -0
- package/dist/cjs/api/resources/agent/types/AgentAttachHumanResponse.d.ts +9 -0
- package/dist/cjs/api/resources/agent/types/AgentAttachHumanResponse.js +3 -0
- package/dist/cjs/api/resources/agent/types/AgentSignupRequest.d.ts +5 -2
- package/dist/cjs/api/resources/agent/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/types/index.js +2 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +28 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +98 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryRatesRequest.d.ts +14 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/QueryRatesRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +28 -0
- package/dist/cjs/api/resources/metrics/client/Client.js +98 -0
- package/dist/cjs/api/resources/metrics/client/requests/QueryRatesRequest.d.ts +14 -0
- package/dist/cjs/api/resources/metrics/client/requests/QueryRatesRequest.js +3 -0
- package/dist/cjs/api/resources/metrics/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/metrics/types/QueryRatesResponse.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/types/QueryRatesResponse.js +3 -0
- package/dist/cjs/api/resources/metrics/types/RatePeriod.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/types/RatePeriod.js +3 -0
- package/dist/cjs/api/resources/metrics/types/RatePoint.d.ts +12 -0
- package/dist/cjs/api/resources/metrics/types/RatePoint.js +3 -0
- package/dist/cjs/api/resources/metrics/types/RateType.d.ts +10 -0
- package/dist/cjs/api/resources/metrics/types/RateType.js +13 -0
- package/dist/cjs/api/resources/metrics/types/RateTypes.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/types/RateTypes.js +3 -0
- package/dist/cjs/api/resources/metrics/types/Window.d.ts +6 -0
- package/dist/cjs/api/resources/metrics/types/Window.js +3 -0
- package/dist/cjs/api/resources/metrics/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/metrics/types/index.js +6 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +28 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +98 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryRatesRequest.d.ts +14 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/QueryRatesRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.ts +10 -1
- package/dist/cjs/api/resources/webhooks/types/UpdatePodWebhookRequest.d.ts +2 -2
- package/dist/cjs/serialization/resources/agent/types/AgentAttachHumanRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/agent/types/AgentAttachHumanRequest.js +41 -0
- package/dist/cjs/serialization/resources/agent/types/AgentAttachHumanResponse.d.ts +10 -0
- package/dist/cjs/serialization/resources/agent/types/AgentAttachHumanResponse.js +42 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.d.ts +1 -1
- package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.js +1 -1
- package/dist/cjs/serialization/resources/agent/types/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/agent/types/index.js +2 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.js +1 -0
- package/dist/cjs/serialization/resources/metrics/types/QueryRatesResponse.d.ts +9 -0
- package/dist/cjs/serialization/resources/metrics/types/QueryRatesResponse.js +41 -0
- package/dist/cjs/serialization/resources/metrics/types/RatePeriod.d.ts +7 -0
- package/dist/cjs/serialization/resources/metrics/types/RatePeriod.js +39 -0
- package/dist/cjs/serialization/resources/metrics/types/RatePoint.d.ts +11 -0
- package/dist/cjs/serialization/resources/metrics/types/RatePoint.js +43 -0
- package/dist/cjs/serialization/resources/metrics/types/RateType.d.ts +7 -0
- package/dist/cjs/serialization/resources/metrics/types/RateType.js +39 -0
- package/dist/cjs/serialization/resources/metrics/types/RateTypes.d.ts +8 -0
- package/dist/cjs/serialization/resources/metrics/types/RateTypes.js +40 -0
- package/dist/cjs/serialization/resources/metrics/types/Window.d.ts +7 -0
- package/dist/cjs/serialization/resources/metrics/types/Window.js +39 -0
- package/dist/cjs/serialization/resources/metrics/types/index.d.ts +6 -0
- package/dist/cjs/serialization/resources/metrics/types/index.js +6 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agent/client/Client.d.mts +32 -2
- package/dist/esm/api/resources/agent/client/Client.mjs +97 -2
- package/dist/esm/api/resources/agent/types/AgentAttachHumanRequest.d.mts +7 -0
- package/dist/esm/api/resources/agent/types/AgentAttachHumanRequest.mjs +2 -0
- package/dist/esm/api/resources/agent/types/AgentAttachHumanResponse.d.mts +9 -0
- package/dist/esm/api/resources/agent/types/AgentAttachHumanResponse.mjs +2 -0
- package/dist/esm/api/resources/agent/types/AgentSignupRequest.d.mts +5 -2
- package/dist/esm/api/resources/agent/types/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/types/index.mjs +2 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +28 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +98 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryRatesRequest.d.mts +14 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/QueryRatesRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/metrics/client/Client.d.mts +28 -0
- package/dist/esm/api/resources/metrics/client/Client.mjs +98 -0
- package/dist/esm/api/resources/metrics/client/requests/QueryRatesRequest.d.mts +14 -0
- package/dist/esm/api/resources/metrics/client/requests/QueryRatesRequest.mjs +2 -0
- package/dist/esm/api/resources/metrics/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/metrics/types/QueryRatesResponse.d.mts +5 -0
- package/dist/esm/api/resources/metrics/types/QueryRatesResponse.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/RatePeriod.d.mts +5 -0
- package/dist/esm/api/resources/metrics/types/RatePeriod.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/RatePoint.d.mts +12 -0
- package/dist/esm/api/resources/metrics/types/RatePoint.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/RateType.d.mts +10 -0
- package/dist/esm/api/resources/metrics/types/RateType.mjs +10 -0
- package/dist/esm/api/resources/metrics/types/RateTypes.d.mts +5 -0
- package/dist/esm/api/resources/metrics/types/RateTypes.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/Window.d.mts +6 -0
- package/dist/esm/api/resources/metrics/types/Window.mjs +2 -0
- package/dist/esm/api/resources/metrics/types/index.d.mts +6 -0
- package/dist/esm/api/resources/metrics/types/index.mjs +6 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +28 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +98 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryRatesRequest.d.mts +14 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/QueryRatesRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.mts +10 -1
- package/dist/esm/api/resources/webhooks/types/UpdatePodWebhookRequest.d.mts +2 -2
- package/dist/esm/serialization/resources/agent/types/AgentAttachHumanRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/agent/types/AgentAttachHumanRequest.mjs +5 -0
- package/dist/esm/serialization/resources/agent/types/AgentAttachHumanResponse.d.mts +10 -0
- package/dist/esm/serialization/resources/agent/types/AgentAttachHumanResponse.mjs +6 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.d.mts +1 -1
- package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.mjs +1 -1
- package/dist/esm/serialization/resources/agent/types/index.d.mts +2 -0
- package/dist/esm/serialization/resources/agent/types/index.mjs +2 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.mjs +1 -0
- package/dist/esm/serialization/resources/metrics/types/QueryRatesResponse.d.mts +9 -0
- package/dist/esm/serialization/resources/metrics/types/QueryRatesResponse.mjs +5 -0
- package/dist/esm/serialization/resources/metrics/types/RatePeriod.d.mts +7 -0
- package/dist/esm/serialization/resources/metrics/types/RatePeriod.mjs +3 -0
- package/dist/esm/serialization/resources/metrics/types/RatePoint.d.mts +11 -0
- package/dist/esm/serialization/resources/metrics/types/RatePoint.mjs +7 -0
- package/dist/esm/serialization/resources/metrics/types/RateType.d.mts +7 -0
- package/dist/esm/serialization/resources/metrics/types/RateType.mjs +3 -0
- package/dist/esm/serialization/resources/metrics/types/RateTypes.d.mts +8 -0
- package/dist/esm/serialization/resources/metrics/types/RateTypes.mjs +4 -0
- package/dist/esm/serialization/resources/metrics/types/Window.d.mts +7 -0
- package/dist/esm/serialization/resources/metrics/types/Window.mjs +3 -0
- package/dist/esm/serialization/resources/metrics/types/index.d.mts +6 -0
- package/dist/esm/serialization/resources/metrics/types/index.mjs +6 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateInboxWebhookRequest.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms.txt +6 -1
- package/package.json +1 -1
- package/reference.md +329 -2
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../../api/index.mjs";
|
|
2
|
+
import * as core from "../../../../core/index.mjs";
|
|
3
|
+
import type * as serializers from "../../../index.mjs";
|
|
4
|
+
import { RateType } from "./RateType.mjs";
|
|
5
|
+
export declare const RateTypes: core.serialization.Schema<serializers.RateTypes.Raw, AgentMail.RateTypes>;
|
|
6
|
+
export declare namespace RateTypes {
|
|
7
|
+
type Raw = RateType.Raw[];
|
|
8
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../../api/index.mjs";
|
|
2
|
+
import * as core from "../../../../core/index.mjs";
|
|
3
|
+
import type * as serializers from "../../../index.mjs";
|
|
4
|
+
export declare const Window: core.serialization.Schema<serializers.Window.Raw, AgentMail.Window>;
|
|
5
|
+
export declare namespace Window {
|
|
6
|
+
type Raw = number;
|
|
7
|
+
}
|
|
@@ -6,8 +6,14 @@ export * from "./MetricEventTypes.mjs";
|
|
|
6
6
|
export * from "./MetricLimit.mjs";
|
|
7
7
|
export * from "./Period.mjs";
|
|
8
8
|
export * from "./QueryMetricsResponse.mjs";
|
|
9
|
+
export * from "./QueryRatesResponse.mjs";
|
|
9
10
|
export * from "./QueryUsageResponse.mjs";
|
|
11
|
+
export * from "./RatePeriod.mjs";
|
|
12
|
+
export * from "./RatePoint.mjs";
|
|
13
|
+
export * from "./RateType.mjs";
|
|
14
|
+
export * from "./RateTypes.mjs";
|
|
10
15
|
export * from "./Start.mjs";
|
|
11
16
|
export * from "./UsagePoint.mjs";
|
|
12
17
|
export * from "./UsageType.mjs";
|
|
13
18
|
export * from "./UsageTypes.mjs";
|
|
19
|
+
export * from "./Window.mjs";
|
|
@@ -6,8 +6,14 @@ export * from "./MetricEventTypes.mjs";
|
|
|
6
6
|
export * from "./MetricLimit.mjs";
|
|
7
7
|
export * from "./Period.mjs";
|
|
8
8
|
export * from "./QueryMetricsResponse.mjs";
|
|
9
|
+
export * from "./QueryRatesResponse.mjs";
|
|
9
10
|
export * from "./QueryUsageResponse.mjs";
|
|
11
|
+
export * from "./RatePeriod.mjs";
|
|
12
|
+
export * from "./RatePoint.mjs";
|
|
13
|
+
export * from "./RateType.mjs";
|
|
14
|
+
export * from "./RateTypes.mjs";
|
|
10
15
|
export * from "./Start.mjs";
|
|
11
16
|
export * from "./UsagePoint.mjs";
|
|
12
17
|
export * from "./UsageType.mjs";
|
|
13
18
|
export * from "./UsageTypes.mjs";
|
|
19
|
+
export * from "./Window.mjs";
|
|
@@ -3,4 +3,5 @@ import * as core from "../../../../core/index.mjs";
|
|
|
3
3
|
import { UpdateWebhookEventTypes } from "./UpdateWebhookEventTypes.mjs";
|
|
4
4
|
export const UpdateInboxWebhookRequest = core.serialization.object({
|
|
5
5
|
eventTypes: core.serialization.property("event_types", UpdateWebhookEventTypes.optional()),
|
|
6
|
+
enabled: core.serialization.boolean().optional(),
|
|
6
7
|
});
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.5.
|
|
1
|
+
export declare const SDK_VERSION = "0.5.31";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.5.
|
|
1
|
+
export const SDK_VERSION = "0.5.31";
|
package/dist/llms.txt
CHANGED
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
- [AgentID Sign-In](https://docs.agentmail.to/agentid-sign-in.md): Connect an inbox to a provider, authorize a pending AgentID sign-in, and manage sign-in keys with the AgentMail API and CLI.
|
|
40
40
|
- [AgentID Public-Key Authentication](https://docs.agentmail.to/agentid-public-key-authentication.md): Register a public P-256 key, choose its scope and permissions, and manage it through the current AgentMail API Keys endpoints.
|
|
41
41
|
- [Guide: Sending & Receiving Email](https://docs.agentmail.to/sending-receiving-email.md): A step-by-step guide to the practical workflow of sending initial emails and handling replies to have a full conversation.
|
|
42
|
+
- [Reply & Attachment Extraction](https://docs.agentmail.to/reply-extraction.md): AgentMail strips quoted history and boilerplate from every message into extracted_text and extracted_html, and extracts plain text from PDF, Word, Excel, and text attachments. No Talon or reply-parsing library required.
|
|
42
43
|
- [IMAP & SMTP](https://docs.agentmail.to/imap-smtp.md): Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
|
|
43
44
|
- [Guide: Multi-Tenancy](https://docs.agentmail.to/multi-tenancy.md): How to use pods, scoped API keys, and webhook filtering to build multi-tenant email on AgentMail.
|
|
44
45
|
- [Using Custom Domains](https://docs.agentmail.to/custom-domains.md): A step-by-step guide to configuring your custom domain with AgentMail for enhanced branding and trust.
|
|
@@ -59,10 +60,10 @@
|
|
|
59
60
|
- [Live AgentMail Examples](https://docs.agentmail.to/documentation/examples/live-agent-mail-examples.md)
|
|
60
61
|
- [Frequently Asked Questions (FAQ)](https://docs.agentmail.to/faq.md): Find answers to common questions about AgentMail, from core concepts to best practices and security.
|
|
61
62
|
- [Error Reference](https://docs.agentmail.to/errors.md): Every AgentMail API error code, what it means, and how to fix it.
|
|
62
|
-
- [Email Reply Extraction with Talon](https://docs.agentmail.to/talon-reply-extraction.md): Learn how to use Talon to extract new content from email replies, removing quoted text with 93.8% accuracy.
|
|
63
63
|
- [Join the AgentMail Community](https://docs.agentmail.to/community.md): Connect with the AgentMail team and developers, share what you're building, and get support.
|
|
64
64
|
- [Support](https://docs.agentmail.to/support.md): Get help with AgentMail through our support channels.
|
|
65
65
|
- [Understanding Email Authentication (SPF, DKIM, DMARC)](https://docs.agentmail.to/email-protocols.md): Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
|
|
66
|
+
- [24-hour Message Expiry](https://docs.agentmail.to/message-expiry.md): Optional 24-hour message access expiry for your organization. Contact us about early access.
|
|
66
67
|
- [SOC 2 Compliance](https://docs.agentmail.to/documentation/resources/security-privacy/soc-2-compliance.md): AgentMail's completed 2025 SOC 2 Type II audit and 2026 annual audit underway with A-LIGN.
|
|
67
68
|
- [Spam & Virus Detection](https://docs.agentmail.to/spam-virus-detection.md): How AgentMail automatically scans incoming emails for spam and viruses.
|
|
68
69
|
- [API Welcome](https://docs.agentmail.to/api-reference.md): Quick overview of the AgentMail SDK
|
|
@@ -98,6 +99,7 @@
|
|
|
98
99
|
## API Docs
|
|
99
100
|
|
|
100
101
|
- API Reference > Agent [Sign Up](https://docs.agentmail.to/api-reference/agent/sign-up.md)
|
|
102
|
+
- API Reference > Agent [Attach Human](https://docs.agentmail.to/api-reference/agent/attach-human.md)
|
|
101
103
|
- API Reference > Agent [Verify](https://docs.agentmail.to/api-reference/agent/verify.md)
|
|
102
104
|
- API Reference > Inboxes [List Inboxes](https://docs.agentmail.to/api-reference/inboxes/list.md)
|
|
103
105
|
- API Reference > Inboxes [Search Inboxes](https://docs.agentmail.to/api-reference/inboxes/search.md)
|
|
@@ -145,6 +147,7 @@
|
|
|
145
147
|
- API Reference > Inboxes > Lists [Delete List Entry](https://docs.agentmail.to/api-reference/inboxes/lists/delete.md)
|
|
146
148
|
- API Reference > Inboxes > Metrics [Query Events](https://docs.agentmail.to/api-reference/inboxes/metrics/query-events.md)
|
|
147
149
|
- API Reference > Inboxes > Metrics [Query Usage](https://docs.agentmail.to/api-reference/inboxes/metrics/query-usage.md)
|
|
150
|
+
- API Reference > Inboxes > Metrics [Query Rates](https://docs.agentmail.to/api-reference/inboxes/metrics/query-rates.md)
|
|
148
151
|
- API Reference > Inboxes > Events [List Inbox Events](https://docs.agentmail.to/api-reference/inboxes/events/list.md)
|
|
149
152
|
- API Reference > Inboxes > API Keys [List API Keys](https://docs.agentmail.to/api-reference/inboxes/api-keys/list.md)
|
|
150
153
|
- API Reference > Inboxes > API Keys [Create API Key](https://docs.agentmail.to/api-reference/inboxes/api-keys/create.md)
|
|
@@ -191,6 +194,7 @@
|
|
|
191
194
|
- API Reference > Lists [Delete List Entry](https://docs.agentmail.to/api-reference/lists/delete.md)
|
|
192
195
|
- API Reference > Metrics [Query Events](https://docs.agentmail.to/api-reference/metrics/query-events.md)
|
|
193
196
|
- API Reference > Metrics [Query Usage](https://docs.agentmail.to/api-reference/metrics/query-usage.md)
|
|
197
|
+
- API Reference > Metrics [Query Rates](https://docs.agentmail.to/api-reference/metrics/query-rates.md)
|
|
194
198
|
- API Reference > API Keys [List API Keys](https://docs.agentmail.to/api-reference/api-keys/list.md)
|
|
195
199
|
- API Reference > API Keys [Get API Key](https://docs.agentmail.to/api-reference/api-keys/get.md)
|
|
196
200
|
- API Reference > API Keys [Create API Key](https://docs.agentmail.to/api-reference/api-keys/create.md)
|
|
@@ -243,6 +247,7 @@
|
|
|
243
247
|
- API Reference > Pods > Lists [Delete List Entry](https://docs.agentmail.to/api-reference/pods/lists/delete.md)
|
|
244
248
|
- API Reference > Pods > Metrics [Query Events](https://docs.agentmail.to/api-reference/pods/metrics/query-events.md)
|
|
245
249
|
- API Reference > Pods > Metrics [Query Usage](https://docs.agentmail.to/api-reference/pods/metrics/query-usage.md)
|
|
250
|
+
- API Reference > Pods > Metrics [Query Rates](https://docs.agentmail.to/api-reference/pods/metrics/query-rates.md)
|
|
246
251
|
- API Reference > Pods > API Keys [List API Keys](https://docs.agentmail.to/api-reference/pods/api-keys/list.md)
|
|
247
252
|
- API Reference > Pods > API Keys [Create API Key](https://docs.agentmail.to/api-reference/pods/api-keys/create.md)
|
|
248
253
|
- API Reference > Pods > API Keys [Update API Key](https://docs.agentmail.to/api-reference/pods/api-keys/update.md)
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1464,6 +1464,8 @@ Create a new agent organization with an inbox and API key. This endpoint is for
|
|
|
1464
1464
|
|
|
1465
1465
|
A 6-digit OTP is sent to the human's email for verification.
|
|
1466
1466
|
|
|
1467
|
+
`human_email` is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint. There is also no way to recover the API key, so store it durably. Calling sign-up again without `human_email` creates a new organization, which needs a different `username`: the original username stays with the lost organization's inbox.
|
|
1468
|
+
|
|
1467
1469
|
This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
1468
1470
|
|
|
1469
1471
|
The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
@@ -1487,7 +1489,6 @@ agentmail agent sign-up --human-email user@example.com --username my-agent
|
|
|
1487
1489
|
|
|
1488
1490
|
```typescript
|
|
1489
1491
|
await client.agent.signUp({
|
|
1490
|
-
humanEmail: "human_email",
|
|
1491
1492
|
username: "username"
|
|
1492
1493
|
});
|
|
1493
1494
|
|
|
@@ -1521,6 +1522,84 @@ await client.agent.signUp({
|
|
|
1521
1522
|
</dl>
|
|
1522
1523
|
|
|
1523
1524
|
|
|
1525
|
+
</dd>
|
|
1526
|
+
</dl>
|
|
1527
|
+
</details>
|
|
1528
|
+
|
|
1529
|
+
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">attachHuman</a>({ ...params }) -> AgentMail.AgentAttachHumanResponse</code></summary>
|
|
1530
|
+
<dl>
|
|
1531
|
+
<dd>
|
|
1532
|
+
|
|
1533
|
+
#### 📝 Description
|
|
1534
|
+
|
|
1535
|
+
<dl>
|
|
1536
|
+
<dd>
|
|
1537
|
+
|
|
1538
|
+
<dl>
|
|
1539
|
+
<dd>
|
|
1540
|
+
|
|
1541
|
+
Attach a human to an unverified agent organization. A 6-digit OTP is sent to the human's email, which you then submit to the verify endpoint.
|
|
1542
|
+
|
|
1543
|
+
Use it after signing up without a `human_email`. Once the human is attached, the organization can send email to that human only, and verification lifts the remaining restrictions. For up to 5 minutes after attaching, sends to the human can still be rejected with a `429` daily send limit error while the API key's cached limits catch up. Wait and retry.
|
|
1544
|
+
|
|
1545
|
+
Calling it again with the same `human_email` does not rotate the API key. It resends the OTP if it was never delivered, or issues a new one if it expired. While the current OTP is still valid, calling it again keeps that OTP and its attempt count. If all 10 attempts are used up, wait until the OTP expires, 24 hours after it was issued, then call it again for a new one.
|
|
1546
|
+
|
|
1547
|
+
Calling it with a different `human_email` replaces the attached human and sends the new human an OTP. An organization can replace its human at most 2 times.
|
|
1548
|
+
|
|
1549
|
+
Only available until the organization is verified.
|
|
1550
|
+
|
|
1551
|
+
**CLI:**
|
|
1552
|
+
```bash
|
|
1553
|
+
agentmail agent attach-human --human-email user@example.com
|
|
1554
|
+
```
|
|
1555
|
+
</dd>
|
|
1556
|
+
</dl>
|
|
1557
|
+
</dd>
|
|
1558
|
+
</dl>
|
|
1559
|
+
|
|
1560
|
+
#### 🔌 Usage
|
|
1561
|
+
|
|
1562
|
+
<dl>
|
|
1563
|
+
<dd>
|
|
1564
|
+
|
|
1565
|
+
<dl>
|
|
1566
|
+
<dd>
|
|
1567
|
+
|
|
1568
|
+
```typescript
|
|
1569
|
+
await client.agent.attachHuman({
|
|
1570
|
+
humanEmail: "human_email"
|
|
1571
|
+
});
|
|
1572
|
+
|
|
1573
|
+
```
|
|
1574
|
+
</dd>
|
|
1575
|
+
</dl>
|
|
1576
|
+
</dd>
|
|
1577
|
+
</dl>
|
|
1578
|
+
|
|
1579
|
+
#### ⚙️ Parameters
|
|
1580
|
+
|
|
1581
|
+
<dl>
|
|
1582
|
+
<dd>
|
|
1583
|
+
|
|
1584
|
+
<dl>
|
|
1585
|
+
<dd>
|
|
1586
|
+
|
|
1587
|
+
**request:** `AgentMail.AgentAttachHumanRequest`
|
|
1588
|
+
|
|
1589
|
+
</dd>
|
|
1590
|
+
</dl>
|
|
1591
|
+
|
|
1592
|
+
<dl>
|
|
1593
|
+
<dd>
|
|
1594
|
+
|
|
1595
|
+
**requestOptions:** `AgentClient.RequestOptions`
|
|
1596
|
+
|
|
1597
|
+
</dd>
|
|
1598
|
+
</dl>
|
|
1599
|
+
</dd>
|
|
1600
|
+
</dl>
|
|
1601
|
+
|
|
1602
|
+
|
|
1524
1603
|
</dd>
|
|
1525
1604
|
</dl>
|
|
1526
1605
|
</details>
|
|
@@ -1541,7 +1620,7 @@ Verify an agent organization using the 6-digit OTP sent to the human's email dur
|
|
|
1541
1620
|
|
|
1542
1621
|
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
|
|
1543
1622
|
|
|
1544
|
-
The OTP expires after 24 hours and allows a maximum of 10 attempts. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
|
|
1623
|
+
The OTP expires after 24 hours and allows a maximum of 10 attempts. If the OTP expired, call the attach human endpoint with the same `human_email` to get a new one without rotating the API key. Once all 10 attempts are used, even the correct OTP is rejected, and attach human keeps returning the same OTP until it expires, so wait for it to expire before asking for a new one. An organization that signed up without a `human_email` has no OTP until a human is attached. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
|
|
1545
1624
|
|
|
1546
1625
|
**CLI:**
|
|
1547
1626
|
```bash
|
|
@@ -5373,6 +5452,91 @@ await client.inboxes.metrics.queryUsage("inbox_id");
|
|
|
5373
5452
|
</dl>
|
|
5374
5453
|
|
|
5375
5454
|
|
|
5455
|
+
</dd>
|
|
5456
|
+
</dl>
|
|
5457
|
+
</details>
|
|
5458
|
+
|
|
5459
|
+
<details><summary><code>client.inboxes.metrics.<a href="/src/api/resources/inboxes/resources/metrics/client/Client.ts">queryRates</a>(inbox_id, { ...params }) -> AgentMail.QueryRatesResponse</code></summary>
|
|
5460
|
+
<dl>
|
|
5461
|
+
<dd>
|
|
5462
|
+
|
|
5463
|
+
#### 📝 Description
|
|
5464
|
+
|
|
5465
|
+
<dl>
|
|
5466
|
+
<dd>
|
|
5467
|
+
|
|
5468
|
+
<dl>
|
|
5469
|
+
<dd>
|
|
5470
|
+
|
|
5471
|
+
Rolling bounce and complaint rates for the inbox. At each `period`
|
|
5472
|
+
grid point, the bounced (or complained) messages over the preceding
|
|
5473
|
+
`window` divided by the messages sent over the same window, with the
|
|
5474
|
+
send count alongside. Account moderation evaluates the organization-wide
|
|
5475
|
+
rate, so use the organization endpoint to see the number it acts on;
|
|
5476
|
+
the inbox view shows which inboxes contribute. Defaults to the rolling
|
|
5477
|
+
24-hour rate sampled hourly over the last day; `start` must be within
|
|
5478
|
+
the last 90 days, `window` must be a whole multiple of `period`, and
|
|
5479
|
+
the range plus window divided by `period` must not exceed 1000
|
|
5480
|
+
buckets.
|
|
5481
|
+
|
|
5482
|
+
**CLI:**
|
|
5483
|
+
```bash
|
|
5484
|
+
agentmail inboxes metrics query-rates --inbox-id <inbox_id>
|
|
5485
|
+
```
|
|
5486
|
+
</dd>
|
|
5487
|
+
</dl>
|
|
5488
|
+
</dd>
|
|
5489
|
+
</dl>
|
|
5490
|
+
|
|
5491
|
+
#### 🔌 Usage
|
|
5492
|
+
|
|
5493
|
+
<dl>
|
|
5494
|
+
<dd>
|
|
5495
|
+
|
|
5496
|
+
<dl>
|
|
5497
|
+
<dd>
|
|
5498
|
+
|
|
5499
|
+
```typescript
|
|
5500
|
+
await client.inboxes.metrics.queryRates("inbox_id");
|
|
5501
|
+
|
|
5502
|
+
```
|
|
5503
|
+
</dd>
|
|
5504
|
+
</dl>
|
|
5505
|
+
</dd>
|
|
5506
|
+
</dl>
|
|
5507
|
+
|
|
5508
|
+
#### ⚙️ Parameters
|
|
5509
|
+
|
|
5510
|
+
<dl>
|
|
5511
|
+
<dd>
|
|
5512
|
+
|
|
5513
|
+
<dl>
|
|
5514
|
+
<dd>
|
|
5515
|
+
|
|
5516
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
5517
|
+
|
|
5518
|
+
</dd>
|
|
5519
|
+
</dl>
|
|
5520
|
+
|
|
5521
|
+
<dl>
|
|
5522
|
+
<dd>
|
|
5523
|
+
|
|
5524
|
+
**request:** `AgentMail.inboxes.QueryRatesRequest`
|
|
5525
|
+
|
|
5526
|
+
</dd>
|
|
5527
|
+
</dl>
|
|
5528
|
+
|
|
5529
|
+
<dl>
|
|
5530
|
+
<dd>
|
|
5531
|
+
|
|
5532
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
5533
|
+
|
|
5534
|
+
</dd>
|
|
5535
|
+
</dl>
|
|
5536
|
+
</dd>
|
|
5537
|
+
</dl>
|
|
5538
|
+
|
|
5539
|
+
|
|
5376
5540
|
</dd>
|
|
5377
5541
|
</dl>
|
|
5378
5542
|
</details>
|
|
@@ -6855,6 +7019,84 @@ await client.metrics.queryUsage();
|
|
|
6855
7019
|
</dl>
|
|
6856
7020
|
|
|
6857
7021
|
|
|
7022
|
+
</dd>
|
|
7023
|
+
</dl>
|
|
7024
|
+
</details>
|
|
7025
|
+
|
|
7026
|
+
<details><summary><code>client.metrics.<a href="/src/api/resources/metrics/client/Client.ts">queryRates</a>({ ...params }) -> AgentMail.QueryRatesResponse</code></summary>
|
|
7027
|
+
<dl>
|
|
7028
|
+
<dd>
|
|
7029
|
+
|
|
7030
|
+
#### 📝 Description
|
|
7031
|
+
|
|
7032
|
+
<dl>
|
|
7033
|
+
<dd>
|
|
7034
|
+
|
|
7035
|
+
<dl>
|
|
7036
|
+
<dd>
|
|
7037
|
+
|
|
7038
|
+
Rolling bounce and complaint rates for the organization. At each
|
|
7039
|
+
`period` grid point, the bounced (or complained) messages over the
|
|
7040
|
+
preceding `window` divided by the messages sent over the same window,
|
|
7041
|
+
with the send count alongside so you can see the volume behind
|
|
7042
|
+
it. This is the number AgentMail's account moderation acts on: a
|
|
7043
|
+
warning at a 5% bounce rate and suspension at 10%, evaluated over a
|
|
7044
|
+
rolling 24 hours once at least 1,000 messages were sent in that
|
|
7045
|
+
window. Defaults to the rolling 24-hour rate sampled hourly over the
|
|
7046
|
+
last day; `start` must be within the last 90 days, `window` must be a
|
|
7047
|
+
whole multiple of `period`, and the range plus window divided by
|
|
7048
|
+
`period` must not exceed 1000 buckets.
|
|
7049
|
+
|
|
7050
|
+
**CLI:**
|
|
7051
|
+
```bash
|
|
7052
|
+
agentmail metrics query-rates
|
|
7053
|
+
```
|
|
7054
|
+
</dd>
|
|
7055
|
+
</dl>
|
|
7056
|
+
</dd>
|
|
7057
|
+
</dl>
|
|
7058
|
+
|
|
7059
|
+
#### 🔌 Usage
|
|
7060
|
+
|
|
7061
|
+
<dl>
|
|
7062
|
+
<dd>
|
|
7063
|
+
|
|
7064
|
+
<dl>
|
|
7065
|
+
<dd>
|
|
7066
|
+
|
|
7067
|
+
```typescript
|
|
7068
|
+
await client.metrics.queryRates();
|
|
7069
|
+
|
|
7070
|
+
```
|
|
7071
|
+
</dd>
|
|
7072
|
+
</dl>
|
|
7073
|
+
</dd>
|
|
7074
|
+
</dl>
|
|
7075
|
+
|
|
7076
|
+
#### ⚙️ Parameters
|
|
7077
|
+
|
|
7078
|
+
<dl>
|
|
7079
|
+
<dd>
|
|
7080
|
+
|
|
7081
|
+
<dl>
|
|
7082
|
+
<dd>
|
|
7083
|
+
|
|
7084
|
+
**request:** `AgentMail.QueryRatesRequest`
|
|
7085
|
+
|
|
7086
|
+
</dd>
|
|
7087
|
+
</dl>
|
|
7088
|
+
|
|
7089
|
+
<dl>
|
|
7090
|
+
<dd>
|
|
7091
|
+
|
|
7092
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
7093
|
+
|
|
7094
|
+
</dd>
|
|
7095
|
+
</dl>
|
|
7096
|
+
</dd>
|
|
7097
|
+
</dl>
|
|
7098
|
+
|
|
7099
|
+
|
|
6858
7100
|
</dd>
|
|
6859
7101
|
</dl>
|
|
6860
7102
|
</details>
|
|
@@ -9103,6 +9345,91 @@ await client.pods.metrics.queryUsage("pod_id");
|
|
|
9103
9345
|
</dl>
|
|
9104
9346
|
|
|
9105
9347
|
|
|
9348
|
+
</dd>
|
|
9349
|
+
</dl>
|
|
9350
|
+
</details>
|
|
9351
|
+
|
|
9352
|
+
<details><summary><code>client.pods.metrics.<a href="/src/api/resources/pods/resources/metrics/client/Client.ts">queryRates</a>(pod_id, { ...params }) -> AgentMail.QueryRatesResponse</code></summary>
|
|
9353
|
+
<dl>
|
|
9354
|
+
<dd>
|
|
9355
|
+
|
|
9356
|
+
#### 📝 Description
|
|
9357
|
+
|
|
9358
|
+
<dl>
|
|
9359
|
+
<dd>
|
|
9360
|
+
|
|
9361
|
+
<dl>
|
|
9362
|
+
<dd>
|
|
9363
|
+
|
|
9364
|
+
Rolling bounce and complaint rates for the pod. At each `period` grid
|
|
9365
|
+
point, the bounced (or complained) messages over the preceding
|
|
9366
|
+
`window` divided by the messages sent over the same window, with the
|
|
9367
|
+
send count alongside. Account moderation evaluates the organization-wide
|
|
9368
|
+
rate, so use the organization endpoint to see the number it acts on;
|
|
9369
|
+
the pod view shows which pods contribute. Defaults to the rolling
|
|
9370
|
+
24-hour rate sampled hourly over the last day; `start` must be within
|
|
9371
|
+
the last 90 days, `window` must be a whole multiple of `period`, and
|
|
9372
|
+
the range plus window divided by `period` must not exceed 1000
|
|
9373
|
+
buckets.
|
|
9374
|
+
|
|
9375
|
+
**CLI:**
|
|
9376
|
+
```bash
|
|
9377
|
+
agentmail pods metrics query-rates --pod-id <pod_id>
|
|
9378
|
+
```
|
|
9379
|
+
</dd>
|
|
9380
|
+
</dl>
|
|
9381
|
+
</dd>
|
|
9382
|
+
</dl>
|
|
9383
|
+
|
|
9384
|
+
#### 🔌 Usage
|
|
9385
|
+
|
|
9386
|
+
<dl>
|
|
9387
|
+
<dd>
|
|
9388
|
+
|
|
9389
|
+
<dl>
|
|
9390
|
+
<dd>
|
|
9391
|
+
|
|
9392
|
+
```typescript
|
|
9393
|
+
await client.pods.metrics.queryRates("pod_id");
|
|
9394
|
+
|
|
9395
|
+
```
|
|
9396
|
+
</dd>
|
|
9397
|
+
</dl>
|
|
9398
|
+
</dd>
|
|
9399
|
+
</dl>
|
|
9400
|
+
|
|
9401
|
+
#### ⚙️ Parameters
|
|
9402
|
+
|
|
9403
|
+
<dl>
|
|
9404
|
+
<dd>
|
|
9405
|
+
|
|
9406
|
+
<dl>
|
|
9407
|
+
<dd>
|
|
9408
|
+
|
|
9409
|
+
**pod_id:** `AgentMail.PodId`
|
|
9410
|
+
|
|
9411
|
+
</dd>
|
|
9412
|
+
</dl>
|
|
9413
|
+
|
|
9414
|
+
<dl>
|
|
9415
|
+
<dd>
|
|
9416
|
+
|
|
9417
|
+
**request:** `AgentMail.pods.QueryRatesRequest`
|
|
9418
|
+
|
|
9419
|
+
</dd>
|
|
9420
|
+
</dl>
|
|
9421
|
+
|
|
9422
|
+
<dl>
|
|
9423
|
+
<dd>
|
|
9424
|
+
|
|
9425
|
+
**requestOptions:** `MetricsClient.RequestOptions`
|
|
9426
|
+
|
|
9427
|
+
</dd>
|
|
9428
|
+
</dl>
|
|
9429
|
+
</dd>
|
|
9430
|
+
</dl>
|
|
9431
|
+
|
|
9432
|
+
|
|
9106
9433
|
</dd>
|
|
9107
9434
|
</dl>
|
|
9108
9435
|
</details>
|