One read of Claude Developer Platformapi-20260814T043121Z
565 pages moved out of 565 read.
What this read moved
176-200 of 565, page 8 of 23This capture is too large to show at once. Changes 176-200 of 565 are below, significant first; the rest are on the following screens.
api/admin/workspaces/members/delete First recorded · 57 lines, first recorded
## Delete Workspace Member ### Path Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/members/delete
---
## Delete Workspace Member
**delete** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Delete Workspace Member
### Path Parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
### Returns
- `type: "workspace_member_deleted"`
Deleted object type.
For Workspace Members, this is always `"workspace_member_deleted"`.
- `"workspace_member_deleted"`
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"type": "workspace_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```
api/admin/workspaces/members/list First recorded · 104 lines, first recorded
## List Workspace Members ### Path Parameters ### Query Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Workspace Members
url: https://platform.claude.com/docs/en/api/admin/workspaces/members/list
---
## List Workspace Members
**get** `/v1/organizations/workspaces/{workspace_id}/members`
List Workspace Members
### Path Parameters
- `workspace_id: string`
ID of the Workspace.
### Query Parameters
- `after_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
- `before_id: optional string`
ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
### Returns
- `data: array of WorkspaceMember`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
- `"workspace_member"`
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `first_id: string or null`
First ID in the `data` list. Can be used as the `before_id` for the previous page.
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `last_id: string or null`
Last ID in the `data` list. Can be used as the `after_id` for the next page.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"data": [
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
],
"first_id": "first_id",
"has_more": true,
"last_id": "last_id"
}
```
api/admin/workspaces/members/retrieve First recorded · 73 lines, first recorded
## Get Workspace Member ### Path Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/members/retrieve
---
## Get Workspace Member
**get** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Get Workspace Member
### Path Parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
### Returns
- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
- `"workspace_member"`
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
```
api/admin/workspaces/members/update First recorded · 93 lines, first recorded
## Update Workspace Member ### Path Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/members/update
---
## Update Workspace Member
**post** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
Update Workspace Member
### Path Parameters
- `workspace_id: string`
ID of the Workspace.
- `user_id: string`
ID of the User.
### Body Parameters
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
New workspace role for the User.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }`
- `type: "workspace_member"`
Object type.
For Workspace Members, this is always `"workspace_member"`.
- `"workspace_member"`
- `user_id: string`
ID of the User.
- `workspace_id: string`
ID of the Workspace.
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the Workspace Member.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
-d '{
"workspace_role": "workspace_admin"
}'
```
#### Response
```json
{
"type": "workspace_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"workspace_role": "workspace_user"
}
```
api/admin/workspaces/rate_limits First recorded · 202 lines, first recorded
# Rate Limits ## List Workspace Rate Limits ### Path Parameters ### Query Parameters ### Returns ### Example #### Response ## Domain Types ### Rate Limit List Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Rate Limits
url: https://platform.claude.com/docs/en/api/admin/workspaces/rate_limits
---
# Rate Limits
## List Workspace Rate Limits
**get** `/v1/organizations/workspaces/{workspace_id}/rate_limits`
List rate-limit overrides configured for a workspace.
Returns only the groups and limiter types that have a workspace-level
override. Groups without overrides inherit the organization limits and
are not listed; use `GET /v1/organizations/rate_limits` to see those.
### Path Parameters
- `workspace_id: string`
The ID of the workspace.
### Query Parameters
- `group_type: optional "batch" or "files" or "model_group" or 3 more`
Filter by group type.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Returns
- `data: array of object { group_type, limits, models, 3 more }`
Rate-limit entries for the workspace, one per group that has at least one override.
- `group_type: "batch" or "files" or "model_group" or 3 more`
The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `limits: array of object { org_limit, type, value }`
The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
- `org_limit: number or null`
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
- `type: string`
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
- `value: number`
The workspace-level override value for this limiter type.
- `models: array of string or null`
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
- `rate_limit_id: string`
The `id` of the RateLimit group this override applies to.
- `type: "workspace_rate_limit"`
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
- `"workspace_rate_limit"`
- `workspace_id: string`
ID of the Workspace this override applies to.
- `next_page: string or null`
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"data": [
{
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
## Domain Types
### Rate Limit List Response
- `RateLimitListResponse object { data, next_page }`
- `data: array of object { group_type, limits, models, 3 more }`
Rate-limit entries for the workspace, one per group that has at least one override.
- `group_type: "batch" or "files" or "model_group" or 3 more`
The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `limits: array of object { org_limit, type, value }`
The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
- `org_limit: number or null`
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
- `type: string`
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
- `value: number`
The workspace-level override value for this limiter type.
- `models: array of string or null`
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
- `rate_limit_id: string`
The `id` of the RateLimit group this override applies to.
- `type: "workspace_rate_limit"`
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
- `"workspace_rate_limit"`
- `workspace_id: string`
ID of the Workspace this override applies to.
- `next_page: string or null`
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
api/admin/workspaces/rate_limits/list First recorded · 136 lines, first recorded
## List Workspace Rate Limits ### Path Parameters ### Query Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Workspace Rate Limits
url: https://platform.claude.com/docs/en/api/admin/workspaces/rate_limits/list
---
## List Workspace Rate Limits
**get** `/v1/organizations/workspaces/{workspace_id}/rate_limits`
List rate-limit overrides configured for a workspace.
Returns only the groups and limiter types that have a workspace-level
override. Groups without overrides inherit the organization limits and
are not listed; use `GET /v1/organizations/rate_limits` to see those.
### Path Parameters
- `workspace_id: string`
The ID of the workspace.
### Query Parameters
- `group_type: optional "batch" or "files" or "model_group" or 3 more`
Filter by group type.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Returns
- `data: array of object { group_type, limits, models, 3 more }`
Rate-limit entries for the workspace, one per group that has at least one override.
- `group_type: "batch" or "files" or "model_group" or 3 more`
The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.
- `"batch"`
- `"files"`
- `"model_group"`
- `"skills"`
- `"token_count"`
- `"web_search"`
- `limits: array of object { org_limit, type, value }`
The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
- `org_limit: number or null`
The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
- `type: string`
The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
- `value: number`
The workspace-level override value for this limiter type.
- `models: array of string or null`
Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.
- `rate_limit_id: string`
The `id` of the RateLimit group this override applies to.
- `type: "workspace_rate_limit"`
Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
- `"workspace_rate_limit"`
- `workspace_id: string`
ID of the Workspace this override applies to.
- `next_page: string or null`
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"data": [
{
"group_type": "batch",
"limits": [
{
"org_limit": 0,
"type": "type",
"value": 0
}
],
"models": [
"string"
],
"rate_limit_id": "rate_limit_id",
"type": "workspace_rate_limit",
"workspace_id": "workspace_id"
}
],
"next_page": "next_page"
}
```
api/admin/workspaces/retrieve First recorded · 125 lines, first recorded
## Get Workspace ### Path Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Workspace
url: https://platform.claude.com/docs/en/api/admin/workspaces/retrieve
---
## Get Workspace
**get** `/v1/organizations/workspaces/{workspace_id}`
Get Workspace
### Path Parameters
- `workspace_id: string`
ID of the Workspace.
### Returns
- `Workspace object { id, archived_at, compartment_id, 7 more }`
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK integration guide for the
required key configuration, including the value used during key validation.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
- `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`
Data residency configuration.
- `allowed_inference_geos: array of string or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `array of string`
- `"unrestricted"`
- `"unrestricted"`
- `default_inference_geo: string`
Default inference geo applied when requests omit the parameter.
- `workspace_geo: string`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. This
field is write-once: once a key is attached to a Workspace it cannot be
detached or replaced. To rotate key material, rotate the underlying key on
your cloud KMS; the `external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
- `"workspace"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
api/admin/workspaces/service_accounts First recorded · 650 lines, first recorded
# Service Accounts ## Create Service Account Workspace Member ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Service Account Workspace Member ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Service Account Workspace Members ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Service Account Workspace Member ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Service Account Workspace Member ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Service Account Create Response ### Service Account Retrieve Response ### Service Account List Response ### Service Account Update Response ### Service Account Delete Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Service Accounts
url: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts
---
# Service Accounts
## Create Service Account Workspace Member
**post** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
Add a service account to a workspace with the given `workspace_role`.
The role determines what the service account can do in the workspace and
which workspace-scoped permissions it can be granted when authenticating
through federation. Every service account is already an implicit
`workspace_user` member of the default workspace; adding it explicitly
assigns a chosen role. If the service account is already an explicit
member of the workspace, its `workspace_role` is replaced with the
value supplied here. Archived workspaces return 400. Archived service
accounts cannot be added and are rejected. Requires an OAuth bearer or
Console session; Admin API keys are not accepted.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Body Parameters
- `service_account_id: string`
Tagged service account ID to add.
- `workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"`
Role to assign to the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
-d '{
"service_account_id": "service_account_id",
"workspace_role": "workspace_admin"
}'
```
#### Response
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
## Get Service Account Workspace Member
**get** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
Retrieve a service account's membership in a workspace.
Returns the membership record, including the service account's
`workspace_role` in this workspace. Archived workspaces return 400. For
the default workspace, returns the implicit (`implicit: true`)
membership when no explicit membership exists; an explicitly added
membership is returned with its assigned role. An archived service
account returns 404.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
- `service_account_id: string`
ID of the service account.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Returns
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
## List Service Account Workspace Members
**get** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
List the service accounts that are members of a workspace.
Each entry includes the service account's `workspace_role`. Use `limit`
and the `next_page` cursor to paginate. Archived workspaces return 400;
use `GET /service_accounts/{id}/workspaces` to audit memberships of an
archived workspace. The implicit default-workspace membership is not
included in this list. Memberships of archived service accounts are
omitted from the results.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
### Query Parameters
- `limit: optional number`
Number of results per page.
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Returns
- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }`
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `next_page: string or null`
Opaque cursor for the next page, or null if no more results.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
Cut at 300 lines. The page has the rest.
api/admin/workspaces/service_accounts/create First recorded · 114 lines, first recorded
## Create Service Account Workspace Member ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Service Account Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/create
---
## Create Service Account Workspace Member
**post** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
Add a service account to a workspace with the given `workspace_role`.
The role determines what the service account can do in the workspace and
which workspace-scoped permissions it can be granted when authenticating
through federation. Every service account is already an implicit
`workspace_user` member of the default workspace; adding it explicitly
assigns a chosen role. If the service account is already an explicit
member of the workspace, its `workspace_role` is replaced with the
value supplied here. Archived workspaces return 400. Archived service
accounts cannot be added and are rejected. Requires an OAuth bearer or
Console session; Admin API keys are not accepted.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Body Parameters
- `service_account_id: string`
Tagged service account ID to add.
- `workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"`
Role to assign to the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
-d '{
"service_account_id": "service_account_id",
"workspace_role": "workspace_admin"
}'
```
#### Response
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
api/admin/workspaces/service_accounts/delete First recorded · 68 lines, first recorded
## Delete Service Account Workspace Member ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete Service Account Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/delete
---
## Delete Service Account Workspace Member
**delete** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
Remove a service account from a workspace.
Removal is idempotent (returns 200 even if the membership was already
removed). A DELETE against the implicit default-workspace membership
returns 200 but is a no-op and the membership persists; deleting an
explicit default-workspace row reverts to the implicit `workspace_user`
membership. Archived workspaces return 400. Requires an OAuth bearer or
Console session; Admin API keys are not accepted.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
- `service_account_id: string`
ID of the service account.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Returns
- `service_account_id: string`
Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
- `type: "service_account_workspace_member_deleted"`
- `"service_account_workspace_member_deleted"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`) named in the delete request.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"service_account_id": "service_account_id",
"type": "service_account_workspace_member_deleted",
"workspace_id": "workspace_id"
}
```
api/admin/workspaces/service_accounts/list First recorded · 109 lines, first recorded
## List Service Account Workspace Members ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Service Account Workspace Members
url: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/list
---
## List Service Account Workspace Members
**get** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
List the service accounts that are members of a workspace.
Each entry includes the service account's `workspace_role`. Use `limit`
and the `next_page` cursor to paginate. Archived workspaces return 400;
use `GET /service_accounts/{id}/workspaces` to audit memberships of an
archived workspace. The implicit default-workspace membership is not
included in this list. Memberships of archived service accounts are
omitted from the results.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
### Query Parameters
- `limit: optional number`
Number of results per page.
- `page: optional string`
Opaque cursor from a previous response's `next_page`.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Returns
- `data: array of object { created_by_actor_id, implicit, service_account_id, 3 more }`
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
- `next_page: string or null`
Opaque cursor for the next page, or null if no more results.
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"data": [
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
],
"next_page": "next_page"
}
```
api/admin/workspaces/service_accounts/retrieve First recorded · 92 lines, first recorded
## Get Service Account Workspace Member ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Service Account Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/retrieve
---
## Get Service Account Workspace Member
**get** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
Retrieve a service account's membership in a workspace.
Returns the membership record, including the service account's
`workspace_role` in this workspace. Archived workspaces return 400. For
the default workspace, returns the implicit (`implicit: true`)
membership when no explicit membership exists; an explicitly added
membership is returned with its assigned role. An archived service
account returns 404.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
- `service_account_id: string`
ID of the service account.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Returns
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
```
#### Response
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
api/admin/workspaces/service_accounts/update First recorded · 111 lines, first recorded
## Update Service Account Workspace Member ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update Service Account Workspace Member
url: https://platform.claude.com/docs/en/api/admin/workspaces/service_accounts/update
---
## Update Service Account Workspace Member
**post** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
Change a service account's role in a workspace.
The new `workspace_role` replaces the current one. Only explicit
memberships can be updated; to set a role on the implicit
default-workspace membership, add the service account explicitly with
`POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces
return 400. Archived service accounts cannot be updated and are
rejected. Requires an OAuth bearer or Console session; Admin API keys
are not accepted.
### Path Parameters
- `workspace_id: string`
ID of the workspace.
- `service_account_id: string`
ID of the service account.
### Header Parameters
- `"anthropic-beta": optional array of string`
Optional header to specify the beta version(s) you want to use.
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
### Body Parameters
- `workspace_role: "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"`
New role for the service account in this workspace.
- `"workspace_admin"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Returns
- `created_by_actor_id: string or null`
Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
- `implicit: boolean or null`
True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role workspace_user and cannot be removed.
- `service_account_id: string`
Tagged service account ID (`svac_...`).
- `type: "service_account_workspace_member"`
- `"service_account_workspace_member"`
- `workspace_id: string`
Tagged workspace ID (`wrkspc_...`).
- `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role.
- `"workspace_admin"`
- `"workspace_billing"`
- `"workspace_developer"`
- `"workspace_restricted_developer"`
- `"workspace_user"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
-d '{
"workspace_role": "workspace_admin"
}'
```
#### Response
```json
{
"created_by_actor_id": "created_by_actor_id",
"implicit": true,
"service_account_id": "service_account_id",
"type": "service_account_workspace_member",
"workspace_id": "workspace_id",
"workspace_role": "workspace_admin"
}
```
api/admin/workspaces/update First recorded · 177 lines, first recorded
## Update Workspace ### Path Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update Workspace
url: https://platform.claude.com/docs/en/api/admin/workspaces/update
---
## Update Workspace
**post** `/v1/organizations/workspaces/{workspace_id}`
Update Workspace
### Path Parameters
- `workspace_id: string`
### Body Parameters
- `data_residency: optional object { allowed_inference_geos, default_inference_geo } or null`
Data residency configuration for the workspace.
- `allowed_inference_geos: optional array of "global" or "us" or "unrestricted" or null`
Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.
- `array of "global" or "us"`
- `"global"`
- `"us"`
- `"unrestricted"`
- `"unrestricted"`
- `default_inference_geo: optional "global" or "us" or null`
Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is `"unrestricted"`.
- `"global"`
- `"us"`
- `external_key_id: optional string`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. This
field is write-once: once a key is attached to a Workspace it cannot be
detached or replaced. To rotate key material, rotate the underlying key on
your cloud KMS; the `external_key_id` stays the same.
- `name: optional string`
Name of the Workspace.
- `tags: optional map[string] or null`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
### Returns
- `Workspace object { id, archived_at, compartment_id, 7 more }`
- `id: string`
ID of the Workspace.
- `archived_at: string or null`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived.
- `compartment_id: string`
Identifier for this Workspace's encryption compartment. When you configure a
customer-managed encryption key (CMEK) on AWS, reference this value in your
KMS key-policy condition so the key is scoped to this compartment. On GCP and
Azure, Anthropic enforces the compartment binding automatically; you do not
need to reference this value in your key configuration. See the CMEK integration guide for the
required key configuration, including the value used during key validation.
- `created_at: string`
RFC 3339 datetime string indicating when the Workspace was created.
- `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }`
Data residency configuration.
- `allowed_inference_geos: array of string or "unrestricted"`
Permitted inference geo values. 'unrestricted' means all geos are allowed.
- `array of string`
- `"unrestricted"`
- `"unrestricted"`
- `default_inference_geo: string`
Default inference geo applied when requests omit the parameter.
- `workspace_geo: string`
Geographic region for workspace data storage. Immutable after creation.
- `display_color: string`
Hex color code representing the Workspace in the Anthropic Console.
- `external_key_id: string or null`
ID of the customer-managed encryption key (CMEK) configuration to use for this
Workspace. Setting this field requires CMEK to be enabled for your
organization. When set, data stored for this Workspace is encrypted with the
referenced key. Create key configurations with the External Keys API. This
field is write-once: once a key is attached to a Workspace it cannot be
detached or replaced. To rotate key material, rotate the underlying key on
your cloud KMS; the `external_key_id` stays the same.
- `name: string`
Name of the Workspace.
- `tags: map[string]`
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
- `type: "workspace"`
Object type.
For Workspaces, this is always `"workspace"`.
- `"workspace"`
### Example
```http
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" \
-d '{
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"tags": {
"env": "prod",
"team": "platform"
}
}'
```
#### Response
```json
{
"id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
"archived_at": "2024-11-01T23:59:27.427722Z",
"compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
"created_at": "2024-10-30T23:58:27.427722Z",
"data_residency": {
"allowed_inference_geos": "unrestricted",
"default_inference_geo": "default_inference_geo",
"workspace_geo": "workspace_geo"
},
"display_color": "#6C5BB9",
"external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
"name": "Workspace Name",
"tags": {
"env": "prod",
"team": "platform"
},
"type": "workspace"
}
```
api/beta First recorded · 113898 lines, first recorded
# Beta ## Domain Types ### Anthropic Beta ### Beta API Error ### Beta Authentication Error ### Beta Billing Error ### Beta Currency ### Beta Error ### Beta Error Response ### Beta Gateway Timeout Error ### Beta Invalid Request Error ### Beta Monetary Amount ### Beta Not Found Error ### Beta Overloaded Error ### Beta Permission Error ### Beta Rate Limit Error # Models ## List Models ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get a Model ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Capability Support ### Beta Context Management Capability ### Beta Effort Capability ### Beta Model Capabilities ### Beta Model Info ### Beta Thinking Capability ### Beta Thinking Types # Messages ## Create a Message ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Count tokens in a Message ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Advisor Message Iteration Usage ### Beta Advisor Redacted Result Block ### Beta Advisor Redacted Result Block Param ### Beta Advisor Result Block ### Beta Advisor Result Block Param ### Beta Advisor Tool 20260301 ### Beta Advisor Tool Result Block ### Beta Advisor Tool Result Block Param ### Beta Advisor Tool Result Error ### Beta Advisor Tool Result Error Param ### Beta All Thinking Turns ### Beta Base64 Image Source ### Beta Base64 PDF Source ### Beta Bash Code Execution Output Block ### Beta Bash Code Execution Output Block Param ### Beta Bash Code Execution Result Block ### Beta Bash Code Execution Result Block Param ### Beta Bash Code Execution Tool Result Block ### Beta Bash Code Execution Tool Result Block Param ### Beta Bash Code Execution Tool Result Error ### Beta Bash Code Execution Tool Result Error Param ### Beta Cache Control Ephemeral ### Beta Cache Creation ### Beta Cache Miss Messages Changed ### Beta Cache Miss Model Changed ### Beta Cache Miss Previous Message Not Found ### Beta Cache Miss System Changed ### Beta Cache Miss Tools Changed ### Beta Cache Miss Unavailable ### Beta Citation Char Location ### Beta Citation Char Location Param ### Beta Citation Config ### Beta Citation Content Block Location ### Beta Citation Content Block Location Param ### Beta Citation Page Location ### Beta Citation Page Location Param ### Beta Citation Search Result Location ### Beta Citation Search Result Location Param ### Beta Citation Web Search Result Location Param ### Beta Citations Config Param ### Beta Citations Delta ### Beta Citations Web Search Result Location ### Beta Clear Thinking 20251015 Edit ### Beta Clear Thinking 20251015 Edit Response ### Beta Clear Tool Uses 20250919 Edit ### Beta Clear Tool Uses 20250919 Edit Response ### Beta Code Execution Output Block ### Beta Code Execution Output Block Param ### Beta Code Execution Result Block ### Beta Code Execution Result Block Param ### Beta Code Execution Tool 20250522 ### Beta Code Execution Tool 20250825 ### Beta Code Execution Tool 20260120 ### Beta Code Execution Tool 20260521 ### Beta Code Execution Tool Result Block ### Beta Code Execution Tool Result Block Content ### Beta Code Execution Tool Result Block Param ### Beta Code Execution Tool Result Block Param Content ### Beta Code Execution Tool Result Error ### Beta Code Execution Tool Result Error Code ### Beta Code Execution Tool Result Error Param ### Beta Compact 20260112 Edit ### Beta Compaction Block ### Beta Compaction Block Param ### Beta Compaction Content Block Delta ### Beta Compaction Iteration Usage ### Beta Container ### Beta Container Params ### Beta Container Upload Block ### Beta Container Upload Block Param ### Beta Content Block ### Beta Content Block Param ### Beta Content Block Source ### Beta Content Block Source Content ### Beta Context Management Config ### Beta Context Management Response ### Beta Count Tokens Context Management Response ### Beta Diagnostics ### Beta Diagnostics Param ### Beta Direct Caller ### Beta Document Block ### Beta Encrypted Code Execution Result Block ### Beta Encrypted Code Execution Result Block Param ### Beta Fallback Block ### Beta Fallback Block Param ### Beta Fallback Credit Not Applied ### Beta Fallback Credit Redeemed ### Beta Fallback Credit Token Param ### Beta Fallback Credit Usage ### Beta Fallback Info ### Beta Fallback Info Param ### Beta Fallback Message Iteration Usage ### Beta Fallback Param ### Beta Fallback Refusal Trigger ### Beta Fallbacks Param ### Beta File Document Source ### Beta File Image Source ### Beta Image Block Param ### Beta Input JSON Delta ### Beta Input Tokens Clear At Least ### Beta Input Tokens Trigger ### Beta Iterations Usage ### Beta JSON Output Format ### Beta MCP Tool Config ### Beta MCP Tool Default Config ### Beta MCP Tool Result Block ### Beta MCP Tool Use Block ### Beta MCP Tool Use Block Param ### Beta MCP Toolset ### Beta Memory Tool 20250818 ### Beta Memory Tool 20250818 Command ### Beta Memory Tool 20250818 Create Command ### Beta Memory Tool 20250818 Delete Command ### Beta Memory Tool 20250818 Insert Command ### Beta Memory Tool 20250818 Rename Command ### Beta Memory Tool 20250818 Str Replace Command ### Beta Memory Tool 20250818 View Command ### Beta Message ### Beta Message Delta Usage ### Beta Message Iteration Usage ### Beta Message Param ### Beta Message Tokens Count ### Beta Metadata ### Beta Mid Conversation System Block Param ### Beta Output Config ### Beta Output Tokens Details ### Beta Plain Text Source ### Beta Raw Content Block Delta ### Beta Raw Content Block Delta Event ### Beta Raw Content Block Start Event ### Beta Raw Content Block Stop Event ### Beta Raw Message Delta Event ### Beta Raw Message Start Event ### Beta Raw Message Stop Event ### Beta Raw Message Stream Event ### Beta Redacted Thinking Block ### Beta Redacted Thinking Block Param ### Beta Refusal Stop Details ### Beta Request Document Block ### Beta Request MCP Server Tool Configuration ### Beta Request MCP Server URL Definition ### Beta Request MCP Tool Result Block Param ### Beta Request Tool Addition Block ### Beta Request Tool Removal Block ### Beta Search Result Block Param ### Beta Server Tool Caller ### Beta Server Tool Caller 20260120 ### Beta Server Tool Usage ### Beta Server Tool Use Block ### Beta Server Tool Use Block Param ### Beta Signature Delta ### Beta Skill ### Beta Skill Params ### Beta Stop Reason ### Beta Text Block ### Beta Text Block Param ### Beta Text Citation ### Beta Text Citation Param ### Beta Text Delta ### Beta Text Editor Code Execution Create Result Block ### Beta Text Editor Code Execution Create Result Block Param ### Beta Text Editor Code Execution Str Replace Result Block ### Beta Text Editor Code Execution Str Replace Result Block Param ### Beta Text Editor Code Execution Tool Result Block ### Beta Text Editor Code Execution Tool Result Block Param ### Beta Text Editor Code Execution Tool Result Error ### Beta Text Editor Code Execution Tool Result Error Param ### Beta Text Editor Code Execution View Result Block ### Beta Text Editor Code Execution View Result Block Param ### Beta Thinking Block ### Beta Thinking Block Param ### Beta Thinking Config Adaptive ### Beta Thinking Config Disabled ### Beta Thinking Config Enabled ### Beta Thinking Config Param ### Beta Thinking Delta ### Beta Thinking Turns ### Beta Token Task Budget ### Beta Tool ### Beta Tool Bash 20241022 ### Beta Tool Bash 20250124 ### Beta Tool Change MCP Tool Reference ### Beta Tool Change MCP Toolset Reference ### Beta Tool Change Tool Reference ### Beta Tool Choice ### Beta Tool Choice Any ### Beta Tool Choice Auto ### Beta Tool Choice None ### Beta Tool Choice Tool ### Beta Tool Computer Use 20241022 ### Beta Tool Computer Use 20250124 ### Beta Tool Computer Use 20251124 ### Beta Tool Reference Block ### Beta Tool Reference Block Param ### Beta Tool Result Block Param ### Beta Tool Search Tool Bm25 20251119 ### Beta Tool Search Tool Regex 20251119 ### Beta Tool Search Tool Result Block ### Beta Tool Search Tool Result Block Param ### Beta Tool Search Tool Result Error ### Beta Tool Search Tool Result Error Param ### Beta Tool Search Tool Search Result Block ### Beta Tool Search Tool Search Result Block Param ### Beta Tool Text Editor 20241022 ### Beta Tool Text Editor 20250124 ### Beta Tool Text Editor 20250429 ### Beta Tool Text Editor 20250728 ### Beta Tool Union ### Beta Tool Use Block ### Beta Tool Use Block Param ### Beta Tool Uses Keep ### Beta Tool Uses Trigger ### Beta URL Image Source ### Beta URL PDF Source ### Beta Usage ### Beta User Location ### Beta Web Fetch Block ### Beta Web Fetch Block Param ### Beta Web Fetch Tool 20250910 ### Beta Web Fetch Tool 20260209 ### Beta Web Fetch Tool 20260309 ### Beta Web Fetch Tool 20260318 ### Beta Web Fetch Tool Result Block ### Beta Web Fetch Tool Result Block Param ### Beta Web Fetch Tool Result Error Block ### Beta Web Fetch Tool Result Error Block Param ### Beta Web Fetch Tool Result Error Code ### Beta Web Search Result Block ### Beta Web Search Result Block Param ### Beta Web Search Tool 20250305 ### Beta Web Search Tool 20260209 ### Beta Web Search Tool 20260318 ### Beta Web Search Tool Request Error ### Beta Web Search Tool Result Block ### Beta Web Search Tool Result Block Content ### Beta Web Search Tool Result Block Param ### Beta Web Search Tool Result Block Param Content ### Beta Web Search Tool Result Error ### Beta Web Search Tool Result Error Code # Batches ## Create a Message Batch ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Retrieve a Message Batch ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Message Batches ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Cancel a Message Batch ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete a Message Batch ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Retrieve Message Batch results ### Path Parameters ### Header Parameters ### Returns ### Example ## Domain Types ### Beta Deleted Message Batch ### Beta Message Batch ### Beta Message Batch Canceled Result ### Beta Message Batch Errored Result ### Beta Message Batch Expired Result ### Beta Message Batch Individual Response ### Beta Message Batch Request Counts ### Beta Message Batch Result ### Beta Message Batch Succeeded Result # Agents ## Create Agent ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Agents ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Agent ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Agent ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Archive Agent ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Advisor ### Beta Managed Agents Agent ### Beta Managed Agents Agent Reference ### Beta Managed Agents Agent Tool Config ### Beta Managed Agents Agent Tool Config Params ### Beta Managed Agents Agent Toolset Default Config ### Beta Managed Agents Agent Toolset Default Config Params ### Beta Managed Agents Agent Toolset20260401 ### Beta Managed Agents Agent Toolset20260401 Bash Input ### Beta Managed Agents Agent Toolset20260401 Edit Input ### Beta Managed Agents Agent Toolset20260401 Glob Input ### Beta Managed Agents Agent Toolset20260401 Grep Input ### Beta Managed Agents Agent Toolset20260401 Params ### Beta Managed Agents Agent Toolset20260401 Read Input ### Beta Managed Agents Agent Toolset20260401 Write Input ### Beta Managed Agents Always Allow Policy ### Beta Managed Agents Always Ask Policy ### Beta Managed Agents Anthropic Skill ### Beta Managed Agents Anthropic Skill Params ### Beta Managed Agents Custom Skill ### Beta Managed Agents Custom Skill Params ### Beta Managed Agents Custom Tool ### Beta Managed Agents Custom Tool Input Schema ### Beta Managed Agents Custom Tool Params ### Beta Managed Agents Effort High ### Beta Managed Agents Effort Low ### Beta Managed Agents Effort Max ### Beta Managed Agents Effort Medium ### Beta Managed Agents Effort Xhigh ### Beta Managed Agents MCP Server URL Definition ### Beta Managed Agents MCP Tool Config ### Beta Managed Agents MCP Tool Config Params ### Beta Managed Agents MCP Toolset ### Beta Managed Agents MCP Toolset Default Config ### Beta Managed Agents MCP Toolset Default Config Params ### Beta Managed Agents MCP Toolset Params ### Beta Managed Agents Model ### Beta Managed Agents Model Config ### Beta Managed Agents Model Config Params ### Beta Managed Agents Multiagent Coordinator ### Beta Managed Agents Multiagent Coordinator Params ### Beta Managed Agents Multiagent Self Params ### Beta Managed Agents Session Thread Agent ### Beta Managed Agents Skill Params ### Beta Managed Agents URL MCP Server Params # Versions ## List Agent Versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response # Environments ## Create Environment ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Environments ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Environment ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Cloud Config ### Beta Cloud Config Params ### Beta Environment ### Beta Environment Delete Response ### Beta Limited Network ### Beta Limited Network Params ### Beta Packages ### Beta Packages Params ### Beta Self Hosted Config ### Beta Self Hosted Config Params ### Beta Unrestricted Network # Work ## Get Work Item ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Poll for Work ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Acknowledge Work ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Record Heartbeat ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Stop Work ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Work Items ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Work Item ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Queue Statistics ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Self Hosted Work ### Beta Self Hosted Work Heartbeat Response ### Beta Self Hosted Work List Response ### Beta Self Hosted Work Queue Stats ### Beta Self Hosted Work Stop Request ### Beta Self Hosted Work Update Request ### Beta Session Work Data # Sessions ## Create Session ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Sessions ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Session ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Session ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Advisor Params ### Beta Managed Agents Agent Message Preview ### Beta Managed Agents Agent Params ### Beta Managed Agents Agent Thinking Preview ### Beta Managed Agents Agent With Overrides Params ### Beta Managed Agents Branch Checkout ### Beta Managed Agents Budget Limit ### Beta Managed Agents Cache Creation Usage ### Beta Managed Agents Commit Checkout ### Beta Managed Agents Deleted Session ### Beta Managed Agents Delta Content ### Beta Managed Agents Delta Event ### Beta Managed Agents Delta Type ### Beta Managed Agents File Resource Params ### Beta Managed Agents GitHub Repository Resource Params ### Beta Managed Agents Memory Store Resource Param ### Beta Managed Agents Multiagent ### Beta Managed Agents Multiagent Params ### Beta Managed Agents Multiagent Roster Entry Params ### Beta Managed Agents Outcome Evaluation Resource ### Beta Managed Agents Server Tool Usage ### Beta Managed Agents Session ### Beta Managed Agents Session Agent ### Beta Managed Agents Session Agent Update ### Beta Managed Agents Session Multiagent Coordinator ### Beta Managed Agents Session Stats ### Beta Managed Agents Session Updated Event ### Beta Managed Agents Session Usage ### Beta Managed Agents Session Usage Event ### Beta Managed Agents Start Event ### Beta Managed Agents Start Event Preview ### Beta Managed Agents System Content Block ### Beta Managed Agents System Message Event ### Beta Managed Agents User Tool Result Event # Events ## List Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Send Events ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Stream Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Custom Tool Use Event ### Beta Managed Agents Agent MCP Tool Result Event ### Beta Managed Agents Agent MCP Tool Use Event ### Beta Managed Agents Agent Message Event ### Beta Managed Agents Agent Thinking Event ### Beta Managed Agents Agent Thread Context Compacted Event ### Beta Managed Agents Agent Thread Message Received Event ### Beta Managed Agents Agent Thread Message Sent Event ### Beta Managed Agents Agent Tool Result Event ### Beta Managed Agents Agent Tool Use Event ### Beta Managed Agents Base64 Document Source ### Beta Managed Agents Base64 Image Source ### Beta Managed Agents Billing Error ### Beta Managed Agents Credential Host Unreachable Error ### Beta Managed Agents Document Block ### Beta Managed Agents Event Params ### Beta Managed Agents File Document Source ### Beta Managed Agents File Image Source ### Beta Managed Agents File Rubric ### Beta Managed Agents File Rubric Params ### Beta Managed Agents Image Block ### Beta Managed Agents MCP Authentication Failed Error ### Beta Managed Agents MCP Connection Failed Error ### Beta Managed Agents Model Overloaded Error ### Beta Managed Agents Model Rate Limited Error ### Beta Managed Agents Model Request Failed Error ### Beta Managed Agents Plain Text Document Source ### Beta Managed Agents Redacted Block ### Beta Managed Agents Retry Status Exhausted ### Beta Managed Agents Retry Status Retrying ### Beta Managed Agents Retry Status Terminal ### Beta Managed Agents Search Result Block ### Beta Managed Agents Search Result Citations ### Beta Managed Agents Search Result Content ### Beta Managed Agents Send Session Events ### Beta Managed Agents Session Budget Reached ### Beta Managed Agents Session Deleted Event ### Beta Managed Agents Session End Turn ### Beta Managed Agents Session Error Event ### Beta Managed Agents Session Event ### Beta Managed Agents Session Requires Action ### Beta Managed Agents Session Retries Exhausted ### Beta Managed Agents Session Status Idle Event ### Beta Managed Agents Session Status Rescheduled Event ### Beta Managed Agents Session Status Running Event ### Beta Managed Agents Session Status Terminated Event ### Beta Managed Agents Session Thread Created Event ### Beta Managed Agents Session Thread Status Idle Event ### Beta Managed Agents Session Thread Status Rescheduled Event ### Beta Managed Agents Session Thread Status Running Event ### Beta Managed Agents Session Thread Status Terminated Event ### Beta Managed Agents Session Usage Snapshot ### Beta Managed Agents Span Model Request End Event ### Beta Managed Agents Span Model Request Start Event ### Beta Managed Agents Span Model Usage ### Beta Managed Agents Span Outcome Evaluation End Event ### Beta Managed Agents Span Outcome Evaluation Ongoing Event ### Beta Managed Agents Span Outcome Evaluation Start Event ### Beta Managed Agents Stream Session Events ### Beta Managed Agents System Message Event Params ### Beta Managed Agents Text Block ### Beta Managed Agents Text Rubric ### Beta Managed Agents Text Rubric Params ### Beta Managed Agents Unknown Error ### Beta Managed Agents URL Document Source ### Beta Managed Agents URL Image Source ### Beta Managed Agents User Custom Tool Result Event ### Beta Managed Agents User Custom Tool Result Event Params ### Beta Managed Agents User Define Outcome Event ### Beta Managed Agents User Define Outcome Event Params ### Beta Managed Agents User Interrupt Event ### Beta Managed Agents User Interrupt Event Params ### Beta Managed Agents User Message Event ### Beta Managed Agents User Message Event Params ### Beta Managed Agents User Tool Confirmation Event ### Beta Managed Agents User Tool Confirmation Event Params ### Beta Managed Agents User Tool Result Event Params # Resources ## Add Session Resource ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Session Resources ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Session Resource ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Session Resource ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Session Resource ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Delete Session Resource ### Beta Managed Agents File Resource ### Beta Managed Agents GitHub Repository Resource ### Beta Managed Agents Memory Store Resource ### Beta Managed Agents Session Resource ### Resource Retrieve Response ### Resource Update Response # Threads ## List Session Threads ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Session Thread ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Session Thread ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Session Thread ### Beta Managed Agents Session Thread Stats ### Beta Managed Agents Session Thread Status ### Beta Managed Agents Session Thread Usage ### Beta Managed Agents Stream Session Thread Events # Events ## List Session Thread Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Stream Session Thread Events ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response # Deployments ## Create Deployment ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Deployments ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Deployment ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Archive Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Run Deployment Now ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Pause Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Unpause Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Archived Deployment Paused Reason Error ### Beta Managed Agents Cron Schedule ### Beta Managed Agents Cron Schedule Params ### Beta Managed Agents Deployment ### Beta Managed Agents Deployment Initial Event ### Beta Managed Agents Deployment Initial Event Params ### Beta Managed Agents Deployment Paused Reason ### Beta Managed Agents Deployment Paused Reason Error ### Beta Managed Agents Deployment Status ### Beta Managed Agents Deployment System Message Event ### Beta Managed Agents Deployment User Define Outcome Event ### Beta Managed Agents Deployment User Message Event ### Beta Managed Agents Environment Archived Deployment Paused Reason Error ### Beta Managed Agents Environment Not Found Deployment Paused Reason Error ### Beta Managed Agents Error Deployment Paused Reason ### Beta Managed Agents File Not Found Deployment Paused Reason Error ### Beta Managed Agents File Resource Config ### Beta Managed Agents GitHub Repository Resource Config ### Beta Managed Agents Manual Deployment Paused Reason ### Beta Managed Agents MCP Egress Blocked Deployment Paused Reason Error ### Beta Managed Agents Memory Store Archived Deployment Paused Reason Error ### Beta Managed Agents Memory Store Resource Config ### Beta Managed Agents Organization Disabled Deployment Paused Reason Error ### Beta Managed Agents Schedule ### Beta Managed Agents Schedule Params ### Beta Managed Agents Self Hosted Resources Unsupported Deployment Paused Reason Error ### Beta Managed Agents Session Resource Config ### Beta Managed Agents Session Resource Not Found Deployment Paused Reason Error ### Beta Managed Agents Skill Not Found Deployment Paused Reason Error ### Beta Managed Agents Unknown Deployment Paused Reason Error ### Beta Managed Agents Vault Archived Deployment Paused Reason Error ### Beta Managed Agents Vault Not Found Deployment Paused Reason Error ### Beta Managed Agents Workspace Archived Deployment Paused Reason Error # Deployment Runs ## List Deployment Runs ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Deployment Run ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Archived Run Error ### Beta Managed Agents Deployment Run ### Beta Managed Agents Environment Archived Run Error ### Beta Managed Agents Environment Not Found Run Error ### Beta Managed Agents File Not Found Run Error ### Beta Managed Agents Manual Trigger Context ### Beta Managed Agents MCP Egress Blocked Run Error ### Beta Managed Agents Memory Store Archived Run Error ### Beta Managed Agents Organization Disabled Run Error ### Beta Managed Agents Schedule Trigger Context ### Beta Managed Agents Self Hosted Resources Unsupported Run Error ### Beta Managed Agents Session Creation Rejected Run Error ### Beta Managed Agents Session Rate Limited Run Error ### Beta Managed Agents Session Resource Not Found Run Error ### Beta Managed Agents Skill Not Found Run Error ### Beta Managed Agents Trigger Context ### Beta Managed Agents Trigger Type ### Beta Managed Agents Unknown Run Error ### Beta Managed Agents Vault Archived Run Error ### Beta Managed Agents Vault Not Found Run Error ### Beta Managed Agents Workspace Archived Run Error # Vaults ## Create Vault ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Vaults ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Vault ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Deleted Vault ### Beta Managed Agents Vault # Credentials ## Create Credential ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Credentials ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Credential ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Validate Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Credential ### Beta Managed Agents Credential Networking Params ### Beta Managed Agents Credential Validation ### Beta Managed Agents Credential Validation Status ### Beta Managed Agents Deleted Credential ### Beta Managed Agents Environment Variable Auth Response ### Beta Managed Agents Environment Variable Create Params ### Beta Managed Agents Environment Variable Update Params ### Beta Managed Agents Injection Location Params ### Beta Managed Agents Injection Location Response ### Beta Managed Agents Injection Location Update Params ### Beta Managed Agents Limited Credential Networking Params ### Beta Managed Agents Limited Credential Networking Response ### Beta Managed Agents MCP OAuth Auth Response ### Beta Managed Agents MCP OAuth Create Params ### Beta Managed Agents MCP OAuth Refresh Params ### Beta Managed Agents MCP OAuth Refresh Response ### Beta Managed Agents MCP OAuth Refresh Update Params ### Beta Managed Agents MCP OAuth Update Params ### Beta Managed Agents MCP Probe ### Beta Managed Agents Refresh HTTP Response ### Beta Managed Agents Refresh Object ### Beta Managed Agents Static Bearer Auth Response ### Beta Managed Agents Static Bearer Create Params ### Beta Managed Agents Static Bearer Update Params ### Beta Managed Agents Token Endpoint Auth Basic Param ### Beta Managed Agents Token Endpoint Auth Basic Response ### Beta Managed Agents Token Endpoint Auth Basic Update Param ### Beta Managed Agents Token Endpoint Auth None Param ### Beta Managed Agents Token Endpoint Auth None Response ### Beta Managed Agents Token Endpoint Auth Post Param ### Beta Managed Agents Token Endpoint Auth Post Response ### Beta Managed Agents Token Endpoint Auth Post Update Param ### Beta Managed Agents Unrestricted Credential Networking Params ### Beta Managed Agents Unrestricted Credential Networking Response # Memory Stores ## Create a memory store ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List memory stores ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Retrieve a memory store ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update a memory store ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete a memory store ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive a memory store ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Deleted Memory Store ### Beta Managed Agents Memory Store # Memories ## Create a memory ### Path Parameters ### Query Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List memories ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Retrieve a memory ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update a memory ### Path Parameters ### Query Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete a memory ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Conflict Error ### Beta Managed Agents Content Sha256 Precondition ### Beta Managed Agents Deleted Memory ### Beta Managed Agents Error ### Beta Managed Agents Memory ### Beta Managed Agents Memory List Item ### Beta Managed Agents Memory Path Conflict Error ### Beta Managed Agents Memory Precondition Failed Error ### Beta Managed Agents Memory Prefix ### Beta Managed Agents Memory View ### Beta Managed Agents Precondition # Memory Versions ## List memory versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Retrieve a memory version ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Redact a memory version ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Actor ### Beta Managed Agents API Actor ### Beta Managed Agents Memory Version ### Beta Managed Agents Memory Version Operation ### Beta Managed Agents Session Actor ### Beta Managed Agents User Actor # Files ## Upload File ### Header Parameters ### Returns ### Example #### Response ## List Files ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Download File ### Path Parameters ### Header Parameters ### Example ## Get File Metadata ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete File ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta File Scope ### Deleted File ### File Metadata # Skills ## Create Skill ### Header Parameters ### Returns ### Example #### Response ## List Skills ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Skill ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete Skill ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Skill Create Response ### Skill List Response ### Skill Retrieve Response ### Skill Delete Response # Versions ## Create Skill Version ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Skill Versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Download Skill Version Content ### Path Parameters ### Header Parameters ### Example ## Get Skill Version ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Delete Skill Version ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Version Create Response ### Version List Response ### Version Retrieve Response ### Version Delete Response # User Profiles ## Create User Profile ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List User Profiles ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get User Profile ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update User Profile ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Create Enrollment URL ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta User Profile ### Beta User Profile Enrollment URL ### Beta User Profile Trust Grant # Dreams ## Create a Dream ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Dreams ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Cancel a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Dream ### Beta Dream Error ### Beta Dream Input ### Beta Dream Memory Store Input ### Beta Dream Memory Store Output ### Beta Dream Model Config ### Beta Dream Model Config Param ### Beta Dream Output ### Beta Dream Sessions Input ### Beta Dream Status ### Beta Dream Usage # Tunnels ## Create Tunnel ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Tunnel ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Tunnels ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Tunnel ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Reveal Tunnel Token ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Rotate Tunnel Token ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Tunnel ### Beta Tunnel Token # Certificates ## Create Tunnel Certificate ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Tunnel Certificates ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Tunnel Certificate # Webhooks ## Domain Types ### Beta Webhook Agent Archived Event Data ### Beta Webhook Agent Created Event Data ### Beta Webhook Agent Deleted Event Data ### Beta Webhook Agent Updated Event Data ### Beta Webhook Deployment Archived Event Data ### Beta Webhook Deployment Created Event Data ### Beta Webhook Deployment Deleted Event Data ### Beta Webhook Deployment Paused Event Data ### Beta Webhook Deployment Run Failed Event Data ### Beta Webhook Deployment Run Started Event Data ### Beta Webhook Deployment Run Succeeded Event Data ### Beta Webhook Deployment Unpaused Event Data ### Beta Webhook Deployment Updated Event Data ### Beta Webhook Environment Archived Event Data ### Beta Webhook Environment Created Event Data ### Beta Webhook Environment Deleted Event Data ### Beta Webhook Environment Updated Event Data ### Beta Webhook Event ### Beta Webhook Event Data ### Beta Webhook Memory Store Archived Event Data ### Beta Webhook Memory Store Created Event Data ### Beta Webhook Memory Store Deleted Event Data ### Beta Webhook Session Archived Event Data ### Beta Webhook Session Budget Reached Event Data ### Beta Webhook Session Created Event Data ### Beta Webhook Session Deleted Event Data ### Beta Webhook Session Idled Event Data ### Beta Webhook Session Outcome Evaluation Ended Event Data ### Beta Webhook Session Pending Event Data ### Beta Webhook Session Requires Action Event Data ### Beta Webhook Session Running Event Data ### Beta Webhook Session Status Idled Event Data ### Beta Webhook Session Status Rescheduled Event Data ### Beta Webhook Session Status Run Started Event Data ### Beta Webhook Session Status Terminated Event Data ### Beta Webhook Session Thread Created Event Data ### Beta Webhook Session Thread Idled Event Data ### Beta Webhook Session Thread Terminated Event Data ### Beta Webhook Session Updated Event Data ### Beta Webhook Vault Archived Event Data ### Beta Webhook Vault Created Event Data ### Beta Webhook Vault Credential Archived Event Data ### Beta Webhook Vault Credential Created Event Data ### Beta Webhook Vault Credential Deleted Event Data ### Beta Webhook Vault Credential Refresh Failed Event Data ### Beta Webhook Vault Deleted Event Data ### Unwrap Webhook Event
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
The first capture of this source. The page was already there, and this is what it said.
---
title: Beta
url: https://platform.claude.com/docs/en/api/beta
---
# Beta
## Domain Types
### Anthropic Beta
- `AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Beta API Error
- `BetaAPIError object { message, type }`
- `message: string`
- `type: "api_error"`
- `"api_error"`
### Beta Authentication Error
- `BetaAuthenticationError object { message, type }`
- `message: string`
- `type: "authentication_error"`
- `"authentication_error"`
### Beta Billing Error
- `BetaBillingError object { message, type }`
- `message: string`
- `type: "billing_error"`
- `"billing_error"`
### Beta Currency
- `BetaCurrency = "USD"`
- `"USD"`
### Beta Error
- `BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more`
- `BetaInvalidRequestError object { message, type }`
- `message: string`
- `type: "invalid_request_error"`
- `"invalid_request_error"`
- `BetaAuthenticationError object { message, type }`
- `message: string`
- `type: "authentication_error"`
- `"authentication_error"`
- `BetaBillingError object { message, type }`
- `message: string`
- `type: "billing_error"`
- `"billing_error"`
- `BetaPermissionError object { message, type }`
- `message: string`
- `type: "permission_error"`
- `"permission_error"`
- `BetaNotFoundError object { message, type }`
- `message: string`
- `type: "not_found_error"`
- `"not_found_error"`
- `BetaRateLimitError object { message, type }`
- `message: string`
- `type: "rate_limit_error"`
- `"rate_limit_error"`
- `BetaGatewayTimeoutError object { message, type }`
- `message: string`
- `type: "timeout_error"`
- `"timeout_error"`
- `BetaAPIError object { message, type }`
- `message: string`
- `type: "api_error"`
- `"api_error"`
- `BetaOverloadedError object { message, type }`
- `message: string`
- `type: "overloaded_error"`
- `"overloaded_error"`
### Beta Error Response
- `BetaErrorResponse object { error, request_id, type }`
- `error: BetaError`
- `BetaInvalidRequestError object { message, type }`
- `message: string`
- `type: "invalid_request_error"`
- `"invalid_request_error"`
- `BetaAuthenticationError object { message, type }`
- `message: string`
- `type: "authentication_error"`
- `"authentication_error"`
- `BetaBillingError object { message, type }`
- `message: string`
- `type: "billing_error"`
- `"billing_error"`
- `BetaPermissionError object { message, type }`
- `message: string`
- `type: "permission_error"`
- `"permission_error"`
- `BetaNotFoundError object { message, type }`
- `message: string`
- `type: "not_found_error"`
- `"not_found_error"`
- `BetaRateLimitError object { message, type }`
- `message: string`
- `type: "rate_limit_error"`
- `"rate_limit_error"`
- `BetaGatewayTimeoutError object { message, type }`
- `message: string`
- `type: "timeout_error"`
- `"timeout_error"`
- `BetaAPIError object { message, type }`
- `message: string`
- `type: "api_error"`
- `"api_error"`
- `BetaOverloadedError object { message, type }`
- `message: string`
- `type: "overloaded_error"`
- `"overloaded_error"`
- `request_id: string or null`
- `type: "error"`
- `"error"`
### Beta Gateway Timeout Error
- `BetaGatewayTimeoutError object { message, type }`
- `message: string`
- `type: "timeout_error"`
- `"timeout_error"`
### Beta Invalid Request Error
- `BetaInvalidRequestError object { message, type }`
- `message: string`
- `type: "invalid_request_error"`
- `"invalid_request_error"`
### Beta Monetary Amount
Cut at 300 lines. The page has the rest.
api/beta-headers First recorded · 220 lines, first recorded
## How to use beta headers ### Multiple beta features ### Endpoint-specific headers ### Version naming conventions ## Error handling ## Getting help ## Next steps
The first capture of this source. The page was already there, and this is what it said.
---
title: Beta headers
url: https://platform.claude.com/docs/en/api/beta-headers
description: Access experimental features before general availability with the `anthropic-beta` header or the SDKs' `betas` parameter.
---
Beta headers allow you to access experimental features and new model capabilities before they become part of the standard API.
<Info>
Each [client SDK](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) exposes a `beta` namespace for calling the API with beta features enabled.
</Info>
## How to use beta headers
To access beta features, include the `anthropic-beta` header in your API requests:
```http
POST /v1/messages
x-api-key: YOUR_API_KEY
anthropic-version: 2023-06-01
anthropic-beta: BETA_FEATURE_NAME
content-type: application/json
```
Each feature's documentation states the exact beta name to send. The [API overview](https://platform.claude.com/docs/en/api/overview) lists the APIs currently in beta.
The following examples show the same request with cURL, the `ant` CLI, and the SDKs. The SDKs take beta names in the `betas` parameter and send the `anthropic-beta` header for you:
<CodeGroup>
```bash cURL
curl https://api.anthropic.com/v1/messages \
-H "x-api-key: $ANTHROPIC_API_KEY" \
-H "anthropic-version: 2023-06-01" \
-H "anthropic-beta: files-api-2025-04-14" \
-H "content-type: application/json" \
-d '{
"model": "claude-opus-5",
"max_tokens": 1024,
"messages": [
{"role": "user", "content": "Hello, Claude"}
]
}'
```
```bash CLI
ant beta:messages create \
--beta files-api-2025-04-14 \
--model claude-opus-5 \
--max-tokens 1024 \
--message '{role: user, content: "Hello, Claude"}'
```
```python Python
client = Anthropic()
response = client.beta.messages.create(
model="claude-opus-5",
max_tokens=1024,
messages=[{"role": "user", "content": "Hello, Claude"}],
betas=["files-api-2025-04-14"],
)
print(response.content)
```
```typescript TypeScript
const client = new Anthropic();
const msg = await client.beta.messages.create({
model: "claude-opus-5",
max_tokens: 1024,
messages: [{ role: "user", content: "Hello, Claude" }],
betas: ["files-api-2025-04-14"]
});
console.log(msg.content);
```
```csharp C#
var client = new AnthropicClient();
var message = await client.Beta.Messages.Create(
new MessageCreateParams
{
Model = "claude-opus-5",
MaxTokens = 1024,
Messages = [new() { Role = Role.User, Content = "Hello, Claude" }],
Betas = ["files-api-2025-04-14"],
}
);
Console.WriteLine(string.Join("\n", message.Content));
```
```go Go
client := anthropic.NewClient()
message, err := client.Beta.Messages.New(context.TODO(), anthropic.BetaMessageNewParams{
Model: anthropic.ModelClaudeOpus5,
MaxTokens: 1024,
Messages: []anthropic.BetaMessageParam{
anthropic.NewBetaUserMessage(anthropic.NewBetaTextBlock("Hello, Claude")),
},
Betas: []anthropic.AnthropicBeta{anthropic.AnthropicBetaFilesAPI2025_04_14},
})
if err != nil {
panic(err)
}
fmt.Printf("%+v\n", message.Content)
```
```java Java
AnthropicClient client = AnthropicOkHttpClient.fromEnv();
MessageCreateParams params = MessageCreateParams.builder()
.model(Model.CLAUDE_OPUS_5)
.maxTokens(1024)
.addUserMessage("Hello, Claude")
.addBeta(AnthropicBeta.FILES_API_2025_04_14)
.build();
BetaMessage message = client.beta().messages().create(params);
System.out.println(message.content());
```
```php PHP
$client = new Client();
$message = $client->beta->messages->create(
maxTokens: 1024,
messages: [['role' => 'user', 'content' => 'Hello, Claude']],
model: 'claude-opus-5',
betas: ['files-api-2025-04-14'],
);
echo $message;
```
```ruby Ruby
client = Anthropic::Client.new
message = client.beta.messages.create(
model: "claude-opus-5",
max_tokens: 1024,
messages: [{role: "user", content: "Hello, Claude"}],
betas: ["files-api-2025-04-14"]
)
puts(message.content)
```
</CodeGroup>
<Warning>
Beta features are experimental and may:
* Have breaking changes with notice
* Be deprecated or removed
* Have different rate limits or pricing
* Not be available in all regions
</Warning>
### Multiple beta features
To use multiple beta features in a single request, include all feature names in the header separated by commas:
```http
anthropic-beta: feature1,feature2,feature3
```
When using an SDK, list each feature in the `betas` parameter (for example, `betas=["feature1", "feature2"]`). With the CLI, pass a single `--beta` flag with the feature names separated by commas (for example, `--beta feature1,feature2`). Avoid repeating the flag: currently only the first flag's value takes effect.
### Endpoint-specific headers
Some beta APIs are scoped to specific endpoints and require a feature-specific beta header on every request:
| Endpoints | Beta header |
| ------------------------------------------------ | --------------------------- |
| `/v1/agents`, `/v1/sessions`, `/v1/environments` | `managed-agents-2026-04-01` |
| `/v1/tunnels` | `mcp-tunnels-2026-06-22` |
| `/v1/memory_stores` and sub-resources | `agent-memory-2026-07-22` |
The SDKs' `beta` namespaces add these headers automatically. Add them yourself only when making raw HTTP requests. See the [Managed Agents overview](https://platform.claude.com/docs/en/managed-agents/overview), [Using agent memory](https://platform.claude.com/docs/en/managed-agents/memory), and the [MCP tunnels reference](https://platform.claude.com/docs/en/agents-and-tools/mcp-tunnels/reference#tunnels-api) for details.
Endpoint-specific headers that apply to the same endpoint aren't always combinable. On memory store endpoints, `agent-memory-2026-07-22` replaces `managed-agents-2026-04-01`: sending both on the same request returns a `400` error. The client SDKs send the correct header for each endpoint automatically.
### Version naming conventions
Beta feature names typically follow the pattern `feature-name-YYYY-MM-DD`, where the date indicates when the beta was released. Always use the exact beta feature name as documented.
## Error handling
If you use an invalid beta name, or a beta your organization doesn't have access to, you'll receive a `400` error response:
```json Output
{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Unexpected value(s) `invalid-beta-name` for the `anthropic-beta` header. Please consult our documentation at platform.claude.com/docs or try again without the header."
},
"request_id": "req_011CcnGfC9fELffo2EALu4Wd"
}
```
## Getting help
For updates to beta features, see the [release notes](https://platform.claude.com/docs/en/release-notes/overview). For help with production issues, contact [support](https://support.claude.com/).
## Next steps
<CardGroup cols={2}>
<Card title="Errors" icon="info" href="https://platform.claude.com/docs/en/api/errors">
Understand the HTTP status codes, error response shape, and request IDs the Claude API returns, and handle errors with the SDKs' typed exceptions.
</Card>
<Card title="API overview" icon="compass" href="https://platform.claude.com/docs/en/api/overview">
Explore the Claude API's features, including the APIs currently in beta.
</Card>
</CardGroup>
api/beta/agents First recorded · 6304 lines, first recorded
# Agents ## Create Agent ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Agents ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Agent ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Agent ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Archive Agent ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Advisor ### Beta Managed Agents Agent ### Beta Managed Agents Agent Reference ### Beta Managed Agents Agent Tool Config ### Beta Managed Agents Agent Tool Config Params ### Beta Managed Agents Agent Toolset Default Config ### Beta Managed Agents Agent Toolset Default Config Params ### Beta Managed Agents Agent Toolset20260401 ### Beta Managed Agents Agent Toolset20260401 Bash Input ### Beta Managed Agents Agent Toolset20260401 Edit Input ### Beta Managed Agents Agent Toolset20260401 Glob Input ### Beta Managed Agents Agent Toolset20260401 Grep Input ### Beta Managed Agents Agent Toolset20260401 Params ### Beta Managed Agents Agent Toolset20260401 Read Input ### Beta Managed Agents Agent Toolset20260401 Write Input ### Beta Managed Agents Always Allow Policy ### Beta Managed Agents Always Ask Policy ### Beta Managed Agents Anthropic Skill ### Beta Managed Agents Anthropic Skill Params ### Beta Managed Agents Custom Skill ### Beta Managed Agents Custom Skill Params ### Beta Managed Agents Custom Tool ### Beta Managed Agents Custom Tool Input Schema ### Beta Managed Agents Custom Tool Params ### Beta Managed Agents Effort High ### Beta Managed Agents Effort Low ### Beta Managed Agents Effort Max ### Beta Managed Agents Effort Medium ### Beta Managed Agents Effort Xhigh ### Beta Managed Agents MCP Server URL Definition ### Beta Managed Agents MCP Tool Config ### Beta Managed Agents MCP Tool Config Params ### Beta Managed Agents MCP Toolset ### Beta Managed Agents MCP Toolset Default Config ### Beta Managed Agents MCP Toolset Default Config Params ### Beta Managed Agents MCP Toolset Params ### Beta Managed Agents Model ### Beta Managed Agents Model Config ### Beta Managed Agents Model Config Params ### Beta Managed Agents Multiagent Coordinator ### Beta Managed Agents Multiagent Coordinator Params ### Beta Managed Agents Multiagent Self Params ### Beta Managed Agents Session Thread Agent ### Beta Managed Agents Skill Params ### Beta Managed Agents URL MCP Server Params # Versions ## List Agent Versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Agents
url: https://platform.claude.com/docs/en/api/beta/agents
---
# Agents
## Create Agent
**post** `/v1/agents`
Create Agent
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control
- `BetaManagedAgentsModel = "claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more or string`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `BetaManagedAgentsModelConfigParams object { id, effort, inference_geo, speed }`
An object that defines additional configuration control over model use
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null`
How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.
- `BetaManagedAgentsEffortLevel = "low" or "medium" or "high" or 2 more`
How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time.
- `"low"`
- `"medium"`
- `"high"`
- `"xhigh"`
- `"max"`
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string or null`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.
- `speed: optional "standard" or "fast" or null`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `name: string`
Human-readable name for the agent.
- `description: optional string or null`
Description of what the agent does.
- `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams`
MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).
- `name: string`
Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
- `type: "url"`
- `"url"`
- `url: string`
Endpoint URL for the MCP server.
- `metadata: optional map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
- `agents: array of BetaManagedAgentsMultiagentRosterEntryParams`
Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{"type":"agent","id","version"}` reference, or `{"type":"self"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1).
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `type: "agent"`
- `"agent"`
- `version: optional number`
The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
- `BetaManagedAgentsMultiagentSelfParams object { type }`
Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.
- `type: "self"`
Cut at 300 lines. The page has the rest.
api/beta/agents/archive First recorded · 548 lines, first recorded
## Archive Agent ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Agent
url: https://platform.claude.com/docs/en/api/beta/agents/archive
---
## Archive Agent
**post** `/v1/agents/{agent_id}/archive`
Archive Agent
### Path Parameters
- `agent_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsAgent object { id, archived_at, created_at, 12 more }`
A Managed Agents `agent`.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
- `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
- `name: string`
- `type: "url"`
- `"url"`
- `url: string`
- `metadata: map[string]`
- `model: BetaManagedAgentsModelConfig`
Model identifier and configuration.
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `multiagent: BetaManagedAgentsMultiagent or null`
Resolved coordinator topology with a concrete agent roster.
- `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor`
Agents the coordinator may spawn as session threads, each resolved to a specific version.
- `BetaManagedAgentsAgentReference object { id, type, version }`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `BetaManagedAgentsAdvisor object { model, type }`
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
- `model: string`
The advisor model id.
- `type: "advisor"`
- `"advisor"`
- `type: "coordinator"`
- `"coordinator"`
- `name: string`
- `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
- `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
A resolved Anthropic-managed skill.
- `skill_id: string`
- `type: "anthropic"`
- `"anthropic"`
- `version: string`
- `BetaManagedAgentsCustomSkill object { skill_id, type, version }`
Cut at 300 lines. The page has the rest.
api/beta/agents/create First recorded · 992 lines, first recorded
## Create Agent ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Agent
url: https://platform.claude.com/docs/en/api/beta/agents/create
---
## Create Agent
**post** `/v1/agents`
Create Agent
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control
- `BetaManagedAgentsModel = "claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more or string`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `BetaManagedAgentsModelConfigParams object { id, effort, inference_geo, speed }`
An object that defines additional configuration control over model use
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null`
How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.
- `BetaManagedAgentsEffortLevel = "low" or "medium" or "high" or 2 more`
How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time.
- `"low"`
- `"medium"`
- `"high"`
- `"xhigh"`
- `"max"`
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string or null`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.
- `speed: optional "standard" or "fast" or null`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `name: string`
Human-readable name for the agent.
- `description: optional string or null`
Description of what the agent does.
- `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams`
MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).
- `name: string`
Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
- `type: "url"`
- `"url"`
- `url: string`
Endpoint URL for the MCP server.
- `metadata: optional map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
- `agents: array of BetaManagedAgentsMultiagentRosterEntryParams`
Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{"type":"agent","id","version"}` reference, or `{"type":"self"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1).
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `type: "agent"`
- `"agent"`
- `version: optional number`
The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
- `BetaManagedAgentsMultiagentSelfParams object { type }`
Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.
- `type: "self"`
- `"self"`
Cut at 300 lines. The page has the rest.
api/beta/agents/list First recorded · 574 lines, first recorded
## List Agents ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Agents
url: https://platform.claude.com/docs/en/api/beta/agents/list
---
## List Agents
**get** `/v1/agents`
List Agents
### Query Parameters
- `"created_at[gte]": optional string`
Return agents created at or after this time (inclusive).
- `"created_at[lte]": optional string`
Return agents created at or before this time (inclusive).
- `include_archived: optional boolean`
Include archived agents in results. Defaults to false.
- `limit: optional number`
Maximum results per page. Default 20, maximum 100.
- `page: optional string`
Opaque pagination cursor from a previous response.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaManagedAgentsAgent`
List of agents.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
- `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
- `name: string`
- `type: "url"`
- `"url"`
- `url: string`
- `metadata: map[string]`
- `model: BetaManagedAgentsModelConfig`
Model identifier and configuration.
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `multiagent: BetaManagedAgentsMultiagent or null`
Resolved coordinator topology with a concrete agent roster.
- `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor`
Agents the coordinator may spawn as session threads, each resolved to a specific version.
- `BetaManagedAgentsAgentReference object { id, type, version }`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `BetaManagedAgentsAdvisor object { model, type }`
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
- `model: string`
The advisor model id.
- `type: "advisor"`
- `"advisor"`
- `type: "coordinator"`
- `"coordinator"`
Cut at 300 lines. The page has the rest.
api/beta/agents/retrieve First recorded · 553 lines, first recorded
## Get Agent ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Agent
url: https://platform.claude.com/docs/en/api/beta/agents/retrieve
---
## Get Agent
**get** `/v1/agents/{agent_id}`
Get Agent
### Path Parameters
- `agent_id: string`
### Query Parameters
- `version: optional number`
Agent version. Omit for the most recent version. Must be at least 1 if specified.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsAgent object { id, archived_at, created_at, 12 more }`
A Managed Agents `agent`.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
- `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
- `name: string`
- `type: "url"`
- `"url"`
- `url: string`
- `metadata: map[string]`
- `model: BetaManagedAgentsModelConfig`
Model identifier and configuration.
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `multiagent: BetaManagedAgentsMultiagent or null`
Resolved coordinator topology with a concrete agent roster.
- `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor`
Agents the coordinator may spawn as session threads, each resolved to a specific version.
- `BetaManagedAgentsAgentReference object { id, type, version }`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `BetaManagedAgentsAdvisor object { model, type }`
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
- `model: string`
The advisor model id.
- `type: "advisor"`
- `"advisor"`
- `type: "coordinator"`
- `"coordinator"`
- `name: string`
- `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
- `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
A resolved Anthropic-managed skill.
- `skill_id: string`
- `type: "anthropic"`
Cut at 300 lines. The page has the rest.
api/beta/agents/update First recorded · 991 lines, first recorded
## Update Agent ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update Agent
url: https://platform.claude.com/docs/en/api/beta/agents/update
---
## Update Agent
**post** `/v1/agents/{agent_id}`
Update Agent
### Path Parameters
- `agent_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `description: optional string or null`
Description. Omit to preserve; send empty string or null to clear.
- `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams or null`
MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).
- `name: string`
Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
- `type: "url"`
- `"url"`
- `url: string`
Endpoint URL for the MCP server.
- `metadata: optional map[string] or null`
Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.
- `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
- `BetaManagedAgentsModel = "claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more or string`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `BetaManagedAgentsModelConfigParams object { id, effort, inference_geo, speed }`
An object that defines additional configuration control over model use
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null`
How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.
- `BetaManagedAgentsEffortLevel = "low" or "medium" or "high" or 2 more`
How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time.
- `"low"`
- `"medium"`
- `"high"`
- `"xhigh"`
- `"max"`
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string or null`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.
- `speed: optional "standard" or "fast" or null`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
- `agents: array of BetaManagedAgentsMultiagentRosterEntryParams`
Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{"type":"agent","id","version"}` reference, or `{"type":"self"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1).
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `type: "agent"`
- `"agent"`
- `version: optional number`
The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
- `BetaManagedAgentsMultiagentSelfParams object { type }`
Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.
- `type: "self"`
- `"self"`
Cut at 300 lines. The page has the rest.
api/beta/agents/versions First recorded · 568 lines, first recorded
# Versions ## List Agent Versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Versions
url: https://platform.claude.com/docs/en/api/beta/agents/versions
---
# Versions
## List Agent Versions
**get** `/v1/agents/{agent_id}/versions`
List Agent Versions
### Path Parameters
- `agent_id: string`
### Query Parameters
- `limit: optional number`
Maximum results per page. Default 20, maximum 100.
- `page: optional string`
Opaque pagination cursor.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaManagedAgentsAgent`
Agent versions.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
- `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
- `name: string`
- `type: "url"`
- `"url"`
- `url: string`
- `metadata: map[string]`
- `model: BetaManagedAgentsModelConfig`
Model identifier and configuration.
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `multiagent: BetaManagedAgentsMultiagent or null`
Resolved coordinator topology with a concrete agent roster.
- `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor`
Agents the coordinator may spawn as session threads, each resolved to a specific version.
- `BetaManagedAgentsAgentReference object { id, type, version }`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `BetaManagedAgentsAdvisor object { model, type }`
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
- `model: string`
The advisor model id.
- `type: "advisor"`
- `"advisor"`
- `type: "coordinator"`
- `"coordinator"`
- `name: string`
- `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
- `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
Cut at 300 lines. The page has the rest.
api/beta/agents/versions/list First recorded · 566 lines, first recorded
## List Agent Versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Agent Versions
url: https://platform.claude.com/docs/en/api/beta/agents/versions/list
---
## List Agent Versions
**get** `/v1/agents/{agent_id}/versions`
List Agent Versions
### Path Parameters
- `agent_id: string`
### Query Parameters
- `limit: optional number`
Maximum results per page. Default 20, maximum 100.
- `page: optional string`
Opaque pagination cursor.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaManagedAgentsAgent`
Agent versions.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
- `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
- `name: string`
- `type: "url"`
- `"url"`
- `url: string`
- `metadata: map[string]`
- `model: BetaManagedAgentsModelConfig`
Model identifier and configuration.
- `id: BetaManagedAgentsModel`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more`
The model that will power your agent.
See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
- `"claude-sonnet-5"`
High-performance model for coding and agents
- `"claude-fable-5"`
Next generation of intelligence for the hardest knowledge work and coding problems
- `"claude-opus-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-8"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-7"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-6"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-6"`
Best combination of speed and intelligence
- `"claude-haiku-4-5"`
Fastest model with near-frontier intelligence
- `"claude-haiku-4-5-20251001"`
Fastest model with near-frontier intelligence
- `"claude-opus-4-5"`
Powerful intelligence for long-running agents and coding
- `"claude-opus-4-5-20251101"`
Powerful intelligence for long-running agents and coding
- `"claude-sonnet-4-5"`
High-performance model for agents and coding
- `"claude-sonnet-4-5-20250929"`
High-performance model for agents and coding
- `string`
- `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
- `BetaManagedAgentsEffortLow object { type }`
Low effort. Favors latency over reasoning depth.
- `type: "low"`
- `"low"`
- `BetaManagedAgentsEffortMedium object { type }`
Medium effort. Balances latency and reasoning depth.
- `type: "medium"`
- `"medium"`
- `BetaManagedAgentsEffortHigh object { type }`
High effort. Favors reasoning depth.
- `type: "high"`
- `"high"`
- `BetaManagedAgentsEffortXhigh object { type }`
Extra-high effort. Not all models accept this level.
- `type: "xhigh"`
- `"xhigh"`
- `BetaManagedAgentsEffortMax object { type }`
Maximum effort. Favors reasoning depth over latency.
- `type: "max"`
- `"max"`
- `inference_geo: optional string`
Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `multiagent: BetaManagedAgentsMultiagent or null`
Resolved coordinator topology with a concrete agent roster.
- `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor`
Agents the coordinator may spawn as session threads, each resolved to a specific version.
- `BetaManagedAgentsAgentReference object { id, type, version }`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `BetaManagedAgentsAdvisor object { model, type }`
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
- `model: string`
The advisor model id.
- `type: "advisor"`
- `"advisor"`
- `type: "coordinator"`
- `"coordinator"`
- `name: string`
- `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
- `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
A resolved Anthropic-managed skill.
Cut at 300 lines. The page has the rest.
api/beta/deployment_runs First recorded · 1353 lines, first recorded
# Deployment Runs ## List Deployment Runs ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Deployment Run ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Archived Run Error ### Beta Managed Agents Deployment Run ### Beta Managed Agents Environment Archived Run Error ### Beta Managed Agents Environment Not Found Run Error ### Beta Managed Agents File Not Found Run Error ### Beta Managed Agents Manual Trigger Context ### Beta Managed Agents MCP Egress Blocked Run Error ### Beta Managed Agents Memory Store Archived Run Error ### Beta Managed Agents Organization Disabled Run Error ### Beta Managed Agents Schedule Trigger Context ### Beta Managed Agents Self Hosted Resources Unsupported Run Error ### Beta Managed Agents Session Creation Rejected Run Error ### Beta Managed Agents Session Rate Limited Run Error ### Beta Managed Agents Session Resource Not Found Run Error ### Beta Managed Agents Skill Not Found Run Error ### Beta Managed Agents Trigger Context ### Beta Managed Agents Trigger Type ### Beta Managed Agents Unknown Run Error ### Beta Managed Agents Vault Archived Run Error ### Beta Managed Agents Vault Not Found Run Error ### Beta Managed Agents Workspace Archived Run Error
The first capture of this source. The page was already there, and this is what it said.
---
title: Deployment Runs
url: https://platform.claude.com/docs/en/api/beta/deployment_runs
---
# Deployment Runs
## List Deployment Runs
**get** `/v1/deployment_runs`
List Deployment Runs
### Query Parameters
- `"created_at[gt]": optional string`
Return runs created strictly after this time (exclusive).
- `"created_at[gte]": optional string`
Return runs created at or after this time (inclusive).
- `"created_at[lt]": optional string`
Return runs created strictly before this time (exclusive).
- `"created_at[lte]": optional string`
Return runs created at or before this time (inclusive).
- `deployment_id: optional string`
Filter to a specific deployment. Omit to list across all deployments in the workspace. Filtering by a non-existent deployment_id returns 200 with empty data.
- `has_error: optional boolean`
Filter: true for runs with non-null error, false for runs with non-null session_id. Omit for all.
- `limit: optional number`
Maximum results per page. Default 20, maximum 1000.
- `page: optional string`
Opaque pagination cursor. Pass next_page from the previous response. Invalid or expired cursors return 400.
- `trigger_type: optional BetaManagedAgentsTriggerType`
Filter runs by what triggered them. Omit to return all runs.
- `"schedule"`
- `"manual"`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaManagedAgentsDeploymentRun`
List of deployment runs.
- `id: string`
Unique identifier for this run (`drun_...`).
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `created_at: string`
A timestamp in RFC 3339 format
- `deployment_id: string`
ID of the deployment that produced this run.
- `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
- `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }`
The deployment's environment was archived.
- `message: string`
Human-readable error description.
- `type: "environment_archived_error"`
- `"environment_archived_error"`
- `BetaManagedAgentsAgentArchivedRunError object { message, type }`
The deployment's agent was archived.
- `message: string`
Human-readable error description.
- `type: "agent_archived_error"`
- `"agent_archived_error"`
- `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }`
The deployment's environment no longer exists.
- `message: string`
Human-readable error description.
- `type: "environment_not_found_error"`
- `"environment_not_found_error"`
- `BetaManagedAgentsVaultNotFoundRunError object { message, type }`
A vault referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "vault_not_found_error"`
- `"vault_not_found_error"`
- `BetaManagedAgentsVaultArchivedRunError object { message, type }`
A vault referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "vault_archived_error"`
- `"vault_archived_error"`
- `BetaManagedAgentsFileNotFoundRunError object { message, type }`
A file resource referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "file_not_found_error"`
- `"file_not_found_error"`
- `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }`
A memory store referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "memory_store_archived_error"`
- `"memory_store_archived_error"`
- `BetaManagedAgentsSkillNotFoundRunError object { message, type }`
A skill referenced by the deployment's agent no longer exists.
- `message: string`
Human-readable error description.
- `type: "skill_not_found_error"`
- `"skill_not_found_error"`
- `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }`
A referenced resource no longer exists and its kind was not reported.
- `message: string`
Human-readable error description.
- `type: "session_resource_not_found_error"`
- `"session_resource_not_found_error"`
- `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }`
The deployment's workspace was archived.
- `message: string`
Human-readable error description.
- `type: "workspace_archived_error"`
- `"workspace_archived_error"`
- `BetaManagedAgentsOrganizationDisabledRunError object { message, type }`
The deployment's organization is disabled.
- `message: string`
Human-readable error description.
- `type: "organization_disabled_error"`
- `"organization_disabled_error"`
- `BetaManagedAgentsSessionRateLimitedRunError object { message, type }`
Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.
Cut at 300 lines. The page has the rest.