apicheats.dev Cheat sheet Raw .md
POST

Try POST /v1/deployments — Claude API

Claude playground

Create Deployment

Credentials

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.anthropic.com; the proxy stores and logs nothing about them.

Headers

Body application/json

10 body fields
  • name · required · string — Human-readable name for the deployment.
  • description · optional · string — Description of what the deployment does.
  • agent · required · string — Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived.
  • environment_id · required · string — ID of the `environment` defining the container configuration for sessions created from this deployment.
  • vault_ids · optional · string[] — Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50.
  • initial_events · required · object[] — Events to send to each session immediately after creation. At least 1, maximum 50.
  • resources · optional · object[] — Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.
  • metadata · optional · object — Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
  • schedule · optional · object — Optional recurring cron schedule. When present, the deployment fires automatically. Both expression and timezone are required when schedule is set.
  • budget · optional · object — Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time. Omit to leave sessions 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.