agentmail 0.4.11 → 0.4.13
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/Client.d.ts +3 -0
- package/dist/cjs/Client.js +27 -22
- package/dist/cjs/api/resources/agent/client/Client.d.ts +50 -0
- package/dist/cjs/api/resources/agent/client/Client.js +199 -0
- package/dist/cjs/api/resources/agent/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agent/client/index.js +2 -0
- package/dist/cjs/api/resources/agent/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/index.js +18 -0
- package/dist/cjs/api/resources/agent/types/AgentSignupRequest.d.ts +9 -0
- package/dist/cjs/api/resources/agent/types/AgentSignupRequest.js +3 -0
- package/dist/cjs/api/resources/agent/types/AgentSignupResponse.d.ts +11 -0
- package/dist/cjs/api/resources/agent/types/AgentSignupResponse.js +3 -0
- package/dist/cjs/api/resources/agent/types/AgentVerifyRequest.d.ts +7 -0
- package/dist/cjs/api/resources/agent/types/AgentVerifyRequest.js +3 -0
- package/dist/cjs/api/resources/agent/types/AgentVerifyResponse.d.ts +7 -0
- package/dist/cjs/api/resources/agent/types/AgentVerifyResponse.js +3 -0
- package/dist/cjs/api/resources/agent/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/agent/types/index.js +20 -0
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +35 -35
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +6 -4
- package/dist/cjs/serialization/resources/agent/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/agent/index.js +17 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.js +42 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupResponse.d.ts +11 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupResponse.js +43 -0
- package/dist/cjs/serialization/resources/agent/types/AgentVerifyRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/agent/types/AgentVerifyRequest.js +41 -0
- package/dist/cjs/serialization/resources/agent/types/AgentVerifyResponse.d.ts +9 -0
- package/dist/cjs/serialization/resources/agent/types/AgentVerifyResponse.js +41 -0
- package/dist/cjs/serialization/resources/agent/types/index.d.ts +4 -0
- package/dist/cjs/serialization/resources/agent/types/index.js +20 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.d.ts +35 -35
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKeyPermissions.js +35 -35
- package/dist/cjs/serialization/resources/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/index.js +3 -1
- 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/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/resources/agent/client/Client.d.mts +50 -0
- package/dist/esm/api/resources/agent/client/Client.mjs +162 -0
- package/dist/esm/api/resources/agent/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agent/client/index.mjs +1 -0
- package/dist/esm/api/resources/agent/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/index.mjs +2 -0
- package/dist/esm/api/resources/agent/types/AgentSignupRequest.d.mts +9 -0
- package/dist/esm/api/resources/agent/types/AgentSignupRequest.mjs +2 -0
- package/dist/esm/api/resources/agent/types/AgentSignupResponse.d.mts +11 -0
- package/dist/esm/api/resources/agent/types/AgentSignupResponse.mjs +2 -0
- package/dist/esm/api/resources/agent/types/AgentVerifyRequest.d.mts +7 -0
- package/dist/esm/api/resources/agent/types/AgentVerifyRequest.mjs +2 -0
- package/dist/esm/api/resources/agent/types/AgentVerifyResponse.d.mts +7 -0
- package/dist/esm/api/resources/agent/types/AgentVerifyResponse.mjs +2 -0
- package/dist/esm/api/resources/agent/types/index.d.mts +4 -0
- package/dist/esm/api/resources/agent/types/index.mjs +4 -0
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +35 -35
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/serialization/resources/agent/index.d.mts +1 -0
- package/dist/esm/serialization/resources/agent/index.mjs +1 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.d.mts +10 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.mjs +6 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupResponse.d.mts +11 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupResponse.mjs +7 -0
- package/dist/esm/serialization/resources/agent/types/AgentVerifyRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/agent/types/AgentVerifyRequest.mjs +5 -0
- package/dist/esm/serialization/resources/agent/types/AgentVerifyResponse.d.mts +9 -0
- package/dist/esm/serialization/resources/agent/types/AgentVerifyResponse.mjs +5 -0
- package/dist/esm/serialization/resources/agent/types/index.d.mts +4 -0
- package/dist/esm/serialization/resources/agent/types/index.mjs +4 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.d.mts +35 -35
- package/dist/esm/serialization/resources/apiKeys/types/ApiKeyPermissions.mjs +35 -35
- package/dist/esm/serialization/resources/index.d.mts +2 -0
- package/dist/esm/serialization/resources/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +1793 -10
- package/dist/llms.txt +4 -0
- package/package.json +1 -1
- package/reference.md +140 -0
package/dist/llms.txt
CHANGED
|
@@ -13,10 +13,12 @@
|
|
|
13
13
|
- [Lists](https://docs.agentmail.to/lists.mdx): Learn how to use Lists to control which email addresses and domains your agents can send to or receive from.
|
|
14
14
|
- [Attachments](https://docs.agentmail.to/attachments.mdx): Learn how to send files as attachments, and download incoming attachments from both messages and threads.
|
|
15
15
|
- [Pods](https://docs.agentmail.to/documentation/core-concepts/pods.mdx): Learn how to use pods for multi-tenant email management
|
|
16
|
+
- [Permissions](https://docs.agentmail.to/permissions.mdx): Learn how to configure fine-grained permissions on API keys to restrict access to specific resources and operations.
|
|
16
17
|
- [Agent Onboarding](https://docs.agentmail.to/agent-onboarding.mdx): Resources for AI coding assistants, MCP servers, skills, and agent-friendly documentation.
|
|
17
18
|
- [Skills](https://docs.agentmail.to/integrations/skills.mdx): AgentMail's official skill for OpenClaw, Claude Code, Cursor, and other AI assistants
|
|
18
19
|
- [MCP](https://docs.agentmail.to/integrations/mcp.mdx): AgentMail's Model Context Protocol (MCP) integration
|
|
19
20
|
- [CLI](https://docs.agentmail.to/integrations/cli.mdx): AgentMail's official command-line interface
|
|
21
|
+
- [Google ADK](https://docs.agentmail.to/integrations/google-adk.mdx): AgentMail's Google Agent Development Kit (ADK) integration
|
|
20
22
|
- [OpenClaw](https://docs.agentmail.to/integrations/openclaw.mdx): AgentMail's OpenClaw integration
|
|
21
23
|
- [Replit](https://docs.agentmail.to/integrations/replit.mdx): AgentMail's Replit integration
|
|
22
24
|
- [x402](https://docs.agentmail.to/integrations/x402.mdx): AgentMail's x402 integration for HTTP-native payments
|
|
@@ -76,6 +78,8 @@
|
|
|
76
78
|
|
|
77
79
|
## API Docs
|
|
78
80
|
|
|
81
|
+
- API Reference > Agent [Sign Up](https://docs.agentmail.to/api-reference/agent/sign-up.mdx)
|
|
82
|
+
- API Reference > Agent [Verify](https://docs.agentmail.to/api-reference/agent/verify.mdx)
|
|
79
83
|
- API Reference > Inboxes [List Inboxes](https://docs.agentmail.to/api-reference/inboxes/list.mdx)
|
|
80
84
|
- API Reference > Inboxes [Get Inbox](https://docs.agentmail.to/api-reference/inboxes/get.mdx)
|
|
81
85
|
- API Reference > Inboxes [Create Inbox](https://docs.agentmail.to/api-reference/inboxes/create.mdx)
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -705,6 +705,146 @@ await client.webhooks.delete("webhook_id");
|
|
|
705
705
|
</dl>
|
|
706
706
|
|
|
707
707
|
|
|
708
|
+
</dd>
|
|
709
|
+
</dl>
|
|
710
|
+
</details>
|
|
711
|
+
|
|
712
|
+
## Agent
|
|
713
|
+
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">signUp</a>({ ...params }) -> AgentMail.AgentSignupResponse</code></summary>
|
|
714
|
+
<dl>
|
|
715
|
+
<dd>
|
|
716
|
+
|
|
717
|
+
#### 📝 Description
|
|
718
|
+
|
|
719
|
+
<dl>
|
|
720
|
+
<dd>
|
|
721
|
+
|
|
722
|
+
<dl>
|
|
723
|
+
<dd>
|
|
724
|
+
|
|
725
|
+
Create a new agent organization with an inbox and API key. A 6-digit OTP is sent to the human's email for verification.
|
|
726
|
+
|
|
727
|
+
This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
728
|
+
|
|
729
|
+
The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
730
|
+
</dd>
|
|
731
|
+
</dl>
|
|
732
|
+
</dd>
|
|
733
|
+
</dl>
|
|
734
|
+
|
|
735
|
+
#### 🔌 Usage
|
|
736
|
+
|
|
737
|
+
<dl>
|
|
738
|
+
<dd>
|
|
739
|
+
|
|
740
|
+
<dl>
|
|
741
|
+
<dd>
|
|
742
|
+
|
|
743
|
+
```typescript
|
|
744
|
+
await client.agent.signUp({
|
|
745
|
+
humanEmail: "human_email",
|
|
746
|
+
username: "username"
|
|
747
|
+
});
|
|
748
|
+
|
|
749
|
+
```
|
|
750
|
+
</dd>
|
|
751
|
+
</dl>
|
|
752
|
+
</dd>
|
|
753
|
+
</dl>
|
|
754
|
+
|
|
755
|
+
#### ⚙️ Parameters
|
|
756
|
+
|
|
757
|
+
<dl>
|
|
758
|
+
<dd>
|
|
759
|
+
|
|
760
|
+
<dl>
|
|
761
|
+
<dd>
|
|
762
|
+
|
|
763
|
+
**request:** `AgentMail.AgentSignupRequest`
|
|
764
|
+
|
|
765
|
+
</dd>
|
|
766
|
+
</dl>
|
|
767
|
+
|
|
768
|
+
<dl>
|
|
769
|
+
<dd>
|
|
770
|
+
|
|
771
|
+
**requestOptions:** `AgentClient.RequestOptions`
|
|
772
|
+
|
|
773
|
+
</dd>
|
|
774
|
+
</dl>
|
|
775
|
+
</dd>
|
|
776
|
+
</dl>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
</dd>
|
|
780
|
+
</dl>
|
|
781
|
+
</details>
|
|
782
|
+
|
|
783
|
+
<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">verify</a>({ ...params }) -> AgentMail.AgentVerifyResponse</code></summary>
|
|
784
|
+
<dl>
|
|
785
|
+
<dd>
|
|
786
|
+
|
|
787
|
+
#### 📝 Description
|
|
788
|
+
|
|
789
|
+
<dl>
|
|
790
|
+
<dd>
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
<dd>
|
|
794
|
+
|
|
795
|
+
Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.
|
|
796
|
+
|
|
797
|
+
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
|
|
798
|
+
|
|
799
|
+
The OTP expires after 24 hours and allows a maximum of 10 attempts.
|
|
800
|
+
</dd>
|
|
801
|
+
</dl>
|
|
802
|
+
</dd>
|
|
803
|
+
</dl>
|
|
804
|
+
|
|
805
|
+
#### 🔌 Usage
|
|
806
|
+
|
|
807
|
+
<dl>
|
|
808
|
+
<dd>
|
|
809
|
+
|
|
810
|
+
<dl>
|
|
811
|
+
<dd>
|
|
812
|
+
|
|
813
|
+
```typescript
|
|
814
|
+
await client.agent.verify({
|
|
815
|
+
otpCode: "otp_code"
|
|
816
|
+
});
|
|
817
|
+
|
|
818
|
+
```
|
|
819
|
+
</dd>
|
|
820
|
+
</dl>
|
|
821
|
+
</dd>
|
|
822
|
+
</dl>
|
|
823
|
+
|
|
824
|
+
#### ⚙️ Parameters
|
|
825
|
+
|
|
826
|
+
<dl>
|
|
827
|
+
<dd>
|
|
828
|
+
|
|
829
|
+
<dl>
|
|
830
|
+
<dd>
|
|
831
|
+
|
|
832
|
+
**request:** `AgentMail.AgentVerifyRequest`
|
|
833
|
+
|
|
834
|
+
</dd>
|
|
835
|
+
</dl>
|
|
836
|
+
|
|
837
|
+
<dl>
|
|
838
|
+
<dd>
|
|
839
|
+
|
|
840
|
+
**requestOptions:** `AgentClient.RequestOptions`
|
|
841
|
+
|
|
842
|
+
</dd>
|
|
843
|
+
</dl>
|
|
844
|
+
</dd>
|
|
845
|
+
</dl>
|
|
846
|
+
|
|
847
|
+
|
|
708
848
|
</dd>
|
|
709
849
|
</dl>
|
|
710
850
|
</details>
|