Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions fern/definition/pods/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ imports:
types:
PodId:
type: string
docs: ID of pod.
docs: ID of pod. A `client_id` can also be used in place of a `pod_id`.

Name:
type: string
Expand Down Expand Up @@ -79,12 +79,16 @@ service:
path: /{pod_id}
display-name: Get Pod
docs: |
Retrieve a pod by its `pod_id` or `client_id`.

**CLI:**
```bash
agentmail pods retrieve --pod-id <pod_id>
```
path-parameters:
pod_id: PodId
pod_id:
type: PodId
docs: The ID of the pod. A `client_id` can also be used.
response: Pod
errors:
- global.NotFoundError
Expand All @@ -108,11 +112,15 @@ service:
path: /{pod_id}
display-name: Delete Pod
docs: |
Delete a pod by its `pod_id` or `client_id`.

**CLI:**
```bash
agentmail pods delete --pod-id <pod_id>
```
path-parameters:
pod_id: PodId
pod_id:
type: PodId
docs: The ID of the pod. A `client_id` can also be used.
errors:
- global.NotFoundError
2 changes: 2 additions & 0 deletions fern/pages/core-concepts/pods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ You can create the following resources **within** a pod:
`organization_id`'s for your customers or segment of your business to our
`pod_id`'s you can just set the `client_id` as your internal id so you can
access the resource using a unique identifier determined by you!

You can pass a `client_id` anywhere a `pod_id` is accepted — for example, `GET /v0/pods/{client_id}` and `DELETE /v0/pods/{client_id}` both work.
</Tip>

These resources are automatically associated with the pod and inherit its isolation guarantees.
Expand Down
Loading