-
Notifications
You must be signed in to change notification settings - Fork 15
docs: add changelog for Pod-scoped API keys #86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
fern-api
wants to merge
2
commits into
main
Choose a base branch
from
fern/changelog-entry
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| tags: ["pods-api", "new-feature"] | ||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| **Pod-scoped API keys** — create API keys that are restricted to a single pod. A pod-scoped key can only access resources within its pod, so multi-tenant platforms can issue narrower credentials per tenant instead of sharing an organization-wide key. | ||
|
|
||
| ### What's new? | ||
|
|
||
| **New endpoints:** | ||
| - `POST /pods/{pod_id}/api-keys` - Create an API key scoped to a pod | ||
| - `GET /pods/{pod_id}/api-keys` - List API keys for a pod | ||
| - `DELETE /pods/{pod_id}/api-keys/{api_key}` - Delete a pod-scoped API key | ||
|
|
||
| **New field:** | ||
| - `pod_id` on API key objects — indicates the pod the key is scoped to. When set, the key can only access resources within that pod. | ||
|
|
||
| ### Use cases | ||
|
|
||
| Build agents that: | ||
| - Issue per-tenant API keys so each customer's agent only accesses its own pod | ||
| - Rotate credentials at the pod level without affecting other tenants | ||
| - Enforce least-privilege access in multi-tenant platforms | ||
| - Audit API key usage per pod | ||
|
|
||
| <CodeBlocks> | ||
| ```python title="Python" | ||
| from agentmail import AgentMail | ||
|
|
||
| client = AgentMail(api_key="your-api-key") | ||
|
|
||
| # create an api key scoped to a pod | ||
| response = client.pods.api_keys.create( | ||
| pod_id="pod_abc123", | ||
| name="tenant-agent-key" | ||
| ) | ||
|
|
||
| # use the scoped key — it can only access this pod's resources | ||
| scoped_client = AgentMail(api_key=response.api_key) | ||
| inboxes = scoped_client.inboxes.list() | ||
| ``` | ||
|
|
||
| ```typescript title="TypeScript" | ||
| import { AgentMail } from "agentmail"; | ||
|
|
||
| const client = new AgentMail({ apiKey: "your-api-key" }); | ||
|
|
||
| // create an api key scoped to a pod | ||
| const response = await client.pods.apiKeys.create("pod_abc123", { | ||
| name: "tenant-agent-key", | ||
| }); | ||
|
|
||
| // use the scoped key — it can only access this pod's resources | ||
| const scopedClient = new AgentMail({ apiKey: response.apiKey }); | ||
| const inboxes = await scopedClient.inboxes.list(); | ||
| ``` | ||
| </CodeBlocks> | ||
|
|
||
| <Note> | ||
| Learn more about multi-tenant isolation in the [Pods](https://docs.agentmail.to/core-concepts/pods) documentation. | ||
| </Note> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P1: This changelog entry documents pod API key endpoints instead of the webhook update endpoint described by the PR, so it publishes the wrong feature in release notes.
Prompt for AI agents