apicheats.dev anthropic/llms.txt Raw .md
POST

POST /v1/deployments/{deployment_id}?beta=true — Claude API

Beta

Anthropic API key (required); https://api.anthropic.com

Claude API

Update Deployment

Base URL
https://api.anthropic.com
Auth
x-api-key: <ANTHROPIC_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 384 tokens · Vary: Accept

Critical gotchas

Authentication uses the x-api-key header and requests also require an anthropic-version header.

The official OpenAPI URL is discovered from the SDK repository manifest and must remain under Anthropic's trusted Stainless storage prefix.

cURL

curl -X POST 'https://api.anthropic.com/v1/deployments/deployment-id?beta=true' \  -H "x-api-key: $ANTHROPIC_API_KEY" \  -H 'anthropic-version: 2023-06-01' \  -H 'Content-Type: application/json' \  -d '{}'

Parameters

Name In Type Required Description
deployment_id path string Yes Path parameter deployment_id
name body string No Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.
description body string No Description. Omit to preserve; send empty string or null to clear.
agent body string No Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared.
environment_id body string No ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.
vault_ids body string[] No Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.
initial_events body object[] No Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.
resources body object[] No Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.
metadata body object No 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.
schedule body object No Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only).
budget body object No Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.

Response 200 OK

{
  "type": "deployment",
  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
  "name": "Daily order report",
  "description": "Compiles yesterday's orders into a report every weekday morning.",
  "agent": {
    "type": "agent",
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "version": 1
  },
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "Compile yesterday's orders into report.md."
        }
      ]
    }
  ],
  "resources": [],
  "metadata": {},
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles",
    "last_run_at": "2026-03-16T16:00:09Z",
    "upcoming_runs_at": [
      "2026-03-17T16:00:00Z",
      "2026-03-18T16:00:00Z"
    ]
  },
  "status": "active",
  "paused_reason": null,
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z",
  "archived_at": null
}
Get a free Claude API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.