Update an agent

⚠️
Preview — this feature is being built; the design below is the spec.
PATCH https://app.syntic.ai/v1/agents/{agent_id}

Change an agent. Every change that alters at least one field creates the next version; running sessions keep the version they started with. Arrays such as tools are replaced whole; metadata is merged key by key, and a null value removes a key. A request that changes nothing returns the current version without creating a new one.

For how this fits into a full workflow, see Agent definitions.

Headers

HeaderRequiredValue
AuthorizationYesBearer <key>: a private inference key (sk_live_...). See Authentication.
syntic-betaYes, while in previewagents-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.
Content-TypeYesapplication/json

Path parameters

ParameterTypeDescription
agent_idstringThe agent id, starting with agt_.

Body parameters

ParameterTypeRequiredNotes
if_versionintegerNoThe version you last read. If the agent has moved on, the call fails with 409 version_conflict instead of overwriting someone else’s change.
namestringNoUnique in the workspace.
modelstringNoFor example Amara S1.2.
instructionsstringNoUp to 100,000 characters.
descriptionstringNoUp to 500 characters.
toolsarrayNoDefault []. Schemas are validated on save.
tool_policyobjectNoDefault {"default": "allow"}. Turning on tools the Console marks as approval-required needs a key created by an Administrator or Owner.
mcp_serversarrayNoDefault [].
skillsarrayNoDefault [].
environment_idstringNoDefault null.
memory_store_idsarrayNoDefault []. Ids must exist in the workspace.
vault_idsarrayNoDefault [].
limitsobjectNoMissing fields take workspace defaults.
metadataobjectNoUp to 16 string pairs.

Response

200 OK, Content-Type: application/json

{
  "id": "agt_01JC4R8W6Q2N9X3T5V7Y",
  "type": "agent",
  "name": "refund-desk",
  "description": "Handles refund requests from the support inbox.",
  "version": 5,
  "status": "active",
  "model": "Amara Deep",
  "instructions": "You handle refund requests for Acme Store. Look the order up before answering.",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "lookup_order",
        "description": "Fetch an order by its id.",
        "parameters": {
          "type": "object",
          "properties": {
            "order_id": {
              "type": "string"
            }
          },
          "required": [
            "order_id"
          ]
        }
      }
    }
  ],
  "tool_policy": {
    "default": "allow",
    "require_approval": [
      "issue_refund"
    ]
  },
  "mcp_servers": [],
  "skills": [],
  "environment_id": null,
  "memory_store_ids": [],
  "vault_ids": [],
  "limits": {
    "max_turns": 30,
    "max_output_tokens_per_turn": 4096,
    "session_token_budget": 400000,
    "session_cost_budget_usd": 2.0
  },
  "metadata": {
    "team": "support"
  },
  "created_at": "2026-11-03T09:14:22Z",
  "updated_at": "2026-11-06T08:30:00Z"
}

Examples

curl -sS -X PATCH https://app.syntic.ai/v1/agents/agt_01JC4R8W6Q2N9X3T5V7Y \
  -H "Authorization: Bearer $SYNTIC_API_KEY" \
  -H "syntic-beta: agents-2026-11-01" \
  -H "Content-Type: application/json" \
  -d '{
      "if_version": 4,
      "model": "Amara Deep"
    }'

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
400invalid_request_errorunknown_modelmodel is not in the catalog.
400invalid_request_errorinvalid_tool_schemaA tool schema is invalid.
403permission_errorrole_requiredThe key’s creator does not hold the role this change needs.
404not_found_erroragent_not_foundNo agent with that id in this workspace.
409conflict_errorversion_conflictif_version is not the current version.
409conflict_errorname_takenThe new name is already used.
401authentication_errorinvalid_api_keyThe key is missing, unknown, revoked or expired.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?