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,025 pages for path.

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

Cancel a Dream Claude Developer Platform · in the page api/beta/dreams/cancel …guages=http#cancel-a-dream) to learn more about canceling dreams. ## Path parameters - `dream_id: string` The ID of the dream to cancel (`drm_...`). ## Headers - `"anthropic-version": optional… Get a Dream Claude Developer Platform · in the page api/beta/dreams/retrieve …ack-progress) for how to poll a dream and what each status means. ## Path parameters - `dream_id: string` The ID of the dream to get (`drm_...`). ## Headers - `"anthropic-version": optional str… Environments Claude Developer Platform · in the page api/beta/environments …nments/{environment_id}` Retrieve a specific environment by ID. ### Path parameters - `environment_id: string` ### Headers - `"anthropic-version": optional string` The version of the Claude AP… Archive Environment Claude Developer Platform · in the page api/beta/environments/archive …ID. Archived environments cannot be used to create new sessions. ## Path parameters - `environment_id: string` ## Headers - `"anthropic-version": optional string` The version of the Claude API… Delete Environment Claude Developer Platform · in the page api/beta/environments/delete …ete an environment by ID. Returns a confirmation of the deletion. ## Path parameters - `environment_id: string` ## Headers - `"anthropic-version": optional string` The version of the Claude API… Get Environment Claude Developer Platform · in the page api/beta/environments/retrieve …onments/{environment_id}` Retrieve a specific environment by ID. ## Path parameters - `environment_id: string` ## Headers - `"anthropic-version": optional string` The version of the Claude API… Update Environment Claude Developer Platform · in the page api/beta/environments/update …environment_id}` Update an existing environment's configuration. ## Path parameters - `environment_id: string` ## Headers - `"anthropic-version": optional string` The version of the Claude API… Work Claude Developer Platform · in the page api/beta/environments/work …ctly. Retrieve detailed information about a specific work item. ### Path parameters - `environment_id: string` - `work_id: string` ### Headers - `"anthropic-version": optional string` The ver… Acknowledge Work Claude Developer Platform · in the page api/beta/environments/work/ack …ng it from 'queued' to 'starting' and removing it from the queue. ## Path parameters - `environment_id: string` - `work_id: string` ## Headers - `"anthropic-version": optional string` The vers… Record Heartbeat Claude Developer Platform · in the page api/beta/environments/work/heartbeat …ectly. Record a heartbeat for a work item to maintain the lease. ## Path parameters - `environment_id: string` - `work_id: string` ## Query parameters - `desired_ttl_seconds: optional number`… List Work Items Claude Developer Platform · in the page api/beta/environments/work/list …need to invoke them directly. List work items in an environment. ## Path parameters - `environment_id: string` ## Query parameters - `limit: optional number` Maximum number of work items to re… Poll for Work Claude Developer Platform · in the page api/beta/environments/work/poll …to invoke them directly. Long poll for work items in the queue. ## Path parameters - `environment_id: string` ## Query parameters - `block_ms: optional number` How long to wait for work to ar… Get Work Item Claude Developer Platform · in the page api/beta/environments/work/retrieve …ectly. Retrieve detailed information about a specific work item. ## Path parameters - `environment_id: string` - `work_id: string` ## Headers - `"anthropic-version": optional string` The vers… Get Queue Statistics Claude Developer Platform · in the page api/beta/environments/work/stats …k/stats` Get statistics about the work queue for an environment. ## Path parameters - `environment_id: string` ## Headers - `"anthropic-version": optional string` The version of the Claude API… Stop Work Claude Developer Platform · in the page api/beta/environments/work/stop …ectly. Stop a work item, initiating graceful or forced shutdown. ## Path parameters - `environment_id: string` - `work_id: string` ## Headers - `"anthropic-version": optional string` The vers… Update Work Item Claude Developer Platform · in the page api/beta/environments/work/update …e them directly. Update work item metadata with merge semantics. ## Path parameters - `environment_id: string` - `work_id: string` ## Headers - `"anthropic-version": optional string` The vers… Files Claude Developer Platform · in the page api/beta/files …s (form-data) - `file: string` The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for t… Delete File Claude Developer Platform · in the page api/beta/files/delete …--- # Delete File **DELETE** `/v1/files/{file_id}` Delete File ## Path parameters - `file_id: string` ID of the File. ## Headers - `"anthropic-version": optional string` The version of th… Download File Claude Developer Platform · in the page api/beta/files/download …wnload File **GET** `/v1/files/{file_id}/content` Download File ## Path parameters - `file_id: string` ID of the File. ## Headers - `"anthropic-version": optional string` The version of th… Get File Metadata Claude Developer Platform · in the page api/beta/files/retrieve_metadata …t File Metadata **GET** `/v1/files/{file_id}` Get File Metadata ## Path parameters - `file_id: string` ID of the File. ## Headers - `"anthropic-version": optional string` The version of th… Upload File Claude Developer Platform · in the page api/beta/files/upload …s (form-data) - `file: string` The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for t… Memory Stores Claude Developer Platform · in the page api/beta/memory_stores …comes one hyphen. The session's memory store resource gives the exact path in `mount_path`. See the [memory guide](https://platform.claude.com/docs/en/managed-agents/memory?sdk_languages=http#how-t… Archive a Memory Store Claude Developer Platform · in the page api/beta/memory_stores/archive …/memory_stores/{memory_store_id}/archive` Archive a Memory Store ## Path parameters - `memory_store_id: string` The ID of the memory store to archive (`memstore_...`). Archiving can't be undo… Create a Memory Store Claude Developer Platform · in the page api/beta/memory_stores/create …comes one hyphen. The session's memory store resource gives the exact path in `mount_path`. See the [memory guide](https://platform.claude.com/docs/en/managed-agents/memory?sdk_languages=http#how-t… Delete a Memory Store Claude Developer Platform · in the page api/beta/memory_stores/delete …TE** `/v1/memory_stores/{memory_store_id}` Delete a Memory Store ## Path parameters - `memory_store_id: string` The ID of the memory store to delete (`memstore_...`). Deleting a store also de… List Memory Stores Claude Developer Platform · in the page api/beta/memory_stores/list …uman-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `updated_at: string` When the memory store was last changed, i… Memories Claude Developer Platform · in the page api/beta/memory_stores/memories …`/v1/memory_stores/{memory_store_id}/memories` Create a Memory ### Path parameters - `memory_store_id: string` The ID of the memory store to create the memory in (`memstore_...`). ### Query pa… Create a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/create …* `/v1/memory_stores/{memory_store_id}/memories` Create a Memory ## Path parameters - `memory_store_id: string` The ID of the memory store to create the memory in (`memstore_...`). ## Query par… Delete a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/delete …y_stores/{memory_store_id}/memories/{memory_id}` Delete a Memory ## Path parameters - `memory_store_id: string` The ID of the memory store that holds the memory (`memstore_...`). - `memory_id:… List Memories Claude Developer Platform · in the page api/beta/memory_stores/memories/list …T** `/v1/memory_stores/{memory_store_id}/memories` List Memories ## Path parameters - `memory_store_id: string` The ID of the memory store to list memories from (`memstore_...`). ## Query param… Retrieve a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/retrieve …stores/{memory_store_id}/memories/{memory_id}` Retrieve a Memory ## Path parameters - `memory_store_id: string` The ID of the memory store that holds the memory (`memstore_...`). - `memory_id:… Update a Memory Claude Developer Platform · in the page api/beta/memory_stores/memories/update …y_stores/{memory_store_id}/memories/{memory_id}` Update a Memory ## Path parameters - `memory_store_id: string` The ID of the memory store that holds the memory (`memstore_...`). - `memory_id:… Memory Versions Claude Developer Platform · in the page api/beta/memory_stores/memory_versions …_stores/{memory_store_id}/memory_versions` List Memory Versions ### Path parameters - `memory_store_id: string` The ID of the memory store whose version history to list (`memstore_...`). ### Qu… List Memory Versions Claude Developer Platform · in the page api/beta/memory_stores/memory_versions/list …y_stores/{memory_store_id}/memory_versions` List Memory Versions ## Path parameters - `memory_store_id: string` The ID of the memory store whose version history to list (`memstore_...`). ## Que… Redact a Memory Version Claude Developer Platform · in the page api/beta/memory_stores/memory_versions/redact …ory_versions/{memory_version_id}/redact` Redact a Memory Version ## Path parameters - `memory_store_id: string` The ID of the memory store that holds the version (`memstore_...`). - `memory_ver… Retrieve a Memory Version Claude Developer Platform · in the page api/beta/memory_stores/memory_versions/retrieve …}/memory_versions/{memory_version_id}` Retrieve a Memory Version ## Path parameters - `memory_store_id: string` The ID of the memory store that holds the version (`memstore_...`). - `memory_ver… Retrieve a Memory Store Claude Developer Platform · in the page api/beta/memory_stores/retrieve …** `/v1/memory_stores/{memory_store_id}` Retrieve a Memory Store ## Path parameters - `memory_store_id: string` The ID of the memory store to retrieve (`memstore_...`). ## Headers - `"anthropi… Update a Memory Store Claude Developer Platform · in the page api/beta/memory_stores/update …ST** `/v1/memory_stores/{memory_store_id}` Update a Memory Store ## Path parameters - `memory_store_id: string` The ID of the memory store to update (`memstore_...`). The request fails with H… Messages Claude Developer Platform · in the page api/beta/messages …pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only includ… Batches Claude Developer Platform · in the page api/beta/messages/batches …ern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only in… Cancel a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/cancel …om/docs/en/build-with-claude/batch-processing?sdk_languages=http) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-version": optional string`… Create a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/create …ern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only in… Delete a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/delete …om/docs/en/build-with-claude/batch-processing?sdk_languages=http) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-version": optional string`… Retrieve Message Batch results Claude Developer Platform · in the page api/beta/messages/batches/results …om/docs/en/build-with-claude/batch-processing?sdk_languages=http) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-version": optional string`… Retrieve a Message Batch Claude Developer Platform · in the page api/beta/messages/batches/retrieve …om/docs/en/build-with-claude/batch-processing?sdk_languages=http) ## Path parameters - `message_batch_id: string` ID of the Message Batch. ## Headers - `"anthropic-version": optional string`… Count tokens in a Message Claude Developer Platform · in the page api/beta/messages/count_tokens …pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only includ… Create a Message Claude Developer Platform · in the page api/beta/messages/create …pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only includ… Models Claude Developer Platform · in the page api/beta/models …n about a specific model or resolve a model alias to a model ID. ### Path parameters - `model_id: string` Model identifier or alias. ### Headers - `"anthropic-version": optional string` The… Get a Model Claude Developer Platform · in the page api/beta/models/retrieve …on about a specific model or resolve a model alias to a model ID. ## Path parameters - `model_id: string` Model identifier or alias. ## Headers - `"anthropic-version": optional string` The v… Organization Claude Developer Platform · in the page api/beta/organization …tps://platform.claude.com/settings/keys) in the Claude Console. #### Path parameters - `api_key_id: string` ID of the API key. #### Headers - `"anthropic-version": optional string` The versi…
Feedback