Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

1,170 pages for default.

Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.

Deployments Claude Developer Platform · in the page api/beta/deployments …ptional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the ac… Archive Deployment Claude Developer Platform · in the page api/beta/deployments/archive …ional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context… Create Deployment Claude Developer Platform · in the page api/beta/deployments/create …ptional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the ac… List Deployments Claude Developer Platform · in the page api/beta/deployments/list …hived: optional boolean` When true, includes archived deployments. Default: false (exclude archived). - `limit: optional number` Maximum results per page. Default 20, maximum 100. format: in… Pause Deployment Claude Developer Platform · in the page api/beta/deployments/pause …ional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context… Get Deployment Claude Developer Platform · in the page api/beta/deployments/retrieve …ional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context… Unpause Deployment Claude Developer Platform · in the page api/beta/deployments/unpause …ional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context… Update Deployment Claude Developer Platform · in the page api/beta/deployments/update …ptional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the ac… Dreams Claude Developer Platform · in the page api/beta/dreams …of a memory store and get back the dream to poll for the result. By default the dream writes its result to a new memory store and doesn't change the input memory store. The response has `status` set… Archive a Dream Claude Developer Platform · in the page api/beta/dreams/archive …/archive` Hide a `completed`, `failed`, or `canceled` dream from the default list of dreams. Archiving a `pending` or `running` dream returns a 400 error, so cancel it first. Archiving an archived d… Cancel a Dream Claude Developer Platform · in the page api/beta/dreams/cancel …ssions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to… Create a Dream Claude Developer Platform · in the page api/beta/dreams/create …of a memory store and get back the dream to poll for the result. By default the dream writes its result to a new memory store and doesn't change the input memory store. The response has `status` set… List Dreams Claude Developer Platform · in the page api/beta/dreams/list …de_archived: optional boolean` Whether to include archived dreams. Defaults to `false`. - `limit: optional number` The maximum number of dreams to return, from 1 to 100. Defaults to 20. form… Get a Dream Claude Developer Platform · in the page api/beta/dreams/retrieve …ssions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to… Environments Claude Developer Platform · in the page api/beta/environments …Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type -… Archive Environment Claude Developer Platform · in the page api/beta/environments/archive …e: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3… Create Environment Claude Developer Platform · in the page api/beta/environments/create …Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type -… Delete Environment Claude Developer Platform · in the page api/beta/environments/delete …nt. - `type: "environment_deleted"` The type of response default: environment_deleted - `id: string` Environment identifier ## Example ```bash curl https://api.anthropic.com/v1/… List Environments Claude Developer Platform · in the page api/beta/environments/list …optional boolean` Include archived environments in the response default: false - `limit: optional number` Maximum number of environments to return default: 20, minimum: 1, maximum: 1000… Get Environment Claude Developer Platform · in the page api/beta/environments/retrieve …e: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3… Update Environment Claude Developer Platform · in the page api/beta/environments/update …Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type -… Work Claude Developer Platform · in the page api/beta/environments/work …box. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 times… Acknowledge Work Claude Developer Platform · in the page api/beta/environments/work/ack …box. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 times… Record Heartbeat Claude Developer Platform · in the page api/beta/environments/work/heartbeat …rk item. - `type: "work_heartbeat"` The type of response default: work_heartbeat - `last_heartbeat: string` RFC 3339 timestamp of the actual heartbeat from DB - `lease_extended… List Work Items Claude Developer Platform · in the page api/beta/environments/work/list …`limit: optional number` Maximum number of work items to return default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from previous response for pagination ## Heade… Poll for Work Claude Developer Platform · in the page api/beta/environments/work/poll …t for work to arrive before returning. Must be 1-999 in milliseconds. Defaults to non-blocking (returns immediately if no work is available). minimum: 1 - `reclaim_older_than_ms: optional number`… Get Work Item Claude Developer Platform · in the page api/beta/environments/work/retrieve …box. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 times… Get Queue Statistics Claude Developer Platform · in the page api/beta/environments/work/stats …queries. - `type: "work_queue_stats"` The type of object default: work_queue_stats - `depth: number` Number of work items waiting to be picked up (lag from consumer group) - `o… Stop Work Claude Developer Platform · in the page api/beta/environments/work/stop …olean` If true, immediately stop work without graceful shutdown default: false ## Returns - `BetaSelfHostedWork object` Work resource representing a unit of work in a self-hosted environmen… Update Work Item Claude Developer Platform · in the page api/beta/environments/work/update …box. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 times… Files Claude Developer Platform · in the page api/beta/files …able: optional boolean` Whether the file can be downloaded. default: false - `expires_at: optional string or null` RFC 3339 datetime string representing when the file will expire and… Delete File Claude Developer Platform · in the page api/beta/files/delete …t type. For file deletion, this is always `"file_deleted"`. default: file_deleted - `id: string` ID of the deleted file. ## Example ```bash curl https://api.anthropic.com/v1/files/… List Files Claude Developer Platform · in the page api/beta/files/list …- `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque page c… Get File Metadata Claude Developer Platform · in the page api/beta/files/retrieve_metadata …able: optional boolean` Whether the file can be downloaded. default: false - `expires_at: optional string or null` RFC 3339 datetime string representing when the file will expire and… Upload File Claude Developer Platform · in the page api/beta/files/upload …able: optional boolean` Whether the file can be downloaded. default: false - `expires_at: optional string or null` RFC 3339 datetime string representing when the file will expire and… Memory Stores Claude Developer Platform · in the page api/beta/memory_stores …boolean` When `true`, archived stores are included in the results. Defaults to `false` (archived stores are excluded). - `limit: optional number` Maximum number of stores to return per page. Mu… List Memory Stores Claude Developer Platform · in the page api/beta/memory_stores/list …boolean` When `true`, archived stores are included in the results. Defaults to `false` (archived stores are excluded). - `limit: optional number` Maximum number of stores to return per page. Mu… Memories Claude Developer Platform · in the page api/beta/memory_stores/memories …`memory` or `memory_version` in the response includes its `content`. Defaults to `full` on retrieve operations and to `basic` on list, create, and update operations. With `full`, list operations r… Create a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/create …`memory` or `memory_version` in the response includes its `content`. Defaults to `full` on retrieve operations and to `basic` on list, create, and update operations. With `full`, list operations r… List Memories Claude Developer Platform · in the page api/beta/memory_stores/memories/list …s - `depth: optional number` How far below `path_prefix` to list. Defaults to `0`, which lists every memory below the prefix. Pass `1` to list only the direct children. Deeper memories are then… Retrieve a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/retrieve …`memory` or `memory_version` in the response includes its `content`. Defaults to `full` on retrieve operations and to `basic` on list, create, and update operations. With `full`, list operations r… Update a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/update …`memory` or `memory_version` in the response includes its `content`. Defaults to `full` on retrieve operations and to `basic` on list, create, and update operations. With `full`, list operations r… Memory Versions Claude Developer Platform · in the page api/beta/memory_stores/memory_versions …The maximum number of versions to return per page, from 1 to 100. Defaults to 20. With `view=full`, a page holds at most 20 versions. format: int32 - `memory_id: optional string` Return… List Memory Versions Claude Developer Platform · in the page api/beta/memory_stores/memory_versions/list …The maximum number of versions to return per page, from 1 to 100. Defaults to 20. With `view=full`, a page holds at most 20 versions. format: int32 - `memory_id: optional string` Return… Retrieve a Memory Version Claude Developer Platform · in the page api/beta/memory_stores/memory_versions/retrieve …`memory` or `memory_version` in the response includes its `content`. Defaults to `full` on retrieve operations and to `basic` on list, create, and update operations. With `full`, list operations r… Messages Claude Developer Platform · in the page api/beta/messages …- `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=… Batches Claude Developer Platform · in the page api/beta/messages/batches …- `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=… Cancel a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/cancel …ype. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time.… Create a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/create …- `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=… Delete a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/delete …For Message Batches, this is always `"message_batch_deleted"`. default: message_batch_deleted - `id: string` ID of the Message Batch. ## Example ```bash curl https://api.anthropic.com…
Feedback