From 609ac8b76897e08da181f00aea31397c51d38e83 Mon Sep 17 00:00:00 2001 From: mini Date: Tue, 31 Mar 2026 22:51:41 -0700 Subject: [PATCH] docs: document client_id as alternative to pod_id in Get/Delete Pod endpoints Co-Authored-By: Claude Opus 4.6 (1M context) --- fern/definition/pods/__package__.yml | 14 +++++++++++--- fern/pages/core-concepts/pods.mdx | 2 ++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/fern/definition/pods/__package__.yml b/fern/definition/pods/__package__.yml index 920b0ea..49b2517 100644 --- a/fern/definition/pods/__package__.yml +++ b/fern/definition/pods/__package__.yml @@ -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 @@ -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 ``` 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 @@ -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 ``` 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 diff --git a/fern/pages/core-concepts/pods.mdx b/fern/pages/core-concepts/pods.mdx index 3b07228..473240a 100644 --- a/fern/pages/core-concepts/pods.mdx +++ b/fern/pages/core-concepts/pods.mdx @@ -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. These resources are automatically associated with the pod and inherit its isolation guarantees.