Management API

Edit Agent

PUT/v1/agent/:id

Programmatically update an existing Agent. Only the fields you provide will be changed — omitted fields keep their current values.

Definition

Path Parameters

Parameter	Type	Required	Description
`id`	string	Yes	The ID of the agent to update

Headers

bash

X-API-Key: YOUR_API_KEY

Body Parameters

Parameter	Type	Required	Description
`environmentId`	string	Yes	ID of the environment the agent belongs to
`name`	string	No	Display name for the agent
`instructions`	string	No	System instructions defining the agent's behavior, persona, and responsibilities
`toolIds`	string[]	No	Replaces the full set of action IDs attached to this agent
`mcpToolIds`	string[]	No	Replaces the full set of MCP tool IDs attached to this agent
`agentType`	string	No	`conversational` or `functional`
`roleName`	string	No	Controls the agent's role. `assistant` handles tasks directly using tools. `orchestration` coordinates a network of sub-agents.
`displayName`	string	No	Optional alternate display name shown in the chat UI
`subAgentIds`	string[]	No	Replaces the full set of sub-agent IDs for orchestration agents. Pass an empty array to remove all sub-agents.
`temperature`	number	No	Model temperature between `0` and `1`
`models`	object[]	No	Custom model configurations. Each entry has `name`, `provider`, `apiKey`, and optional `baseUrl`.
`quickActions`	object[]	No	Pre-defined prompt shortcuts shown in the chat UI. Each has `label` and `text`.
`outputSchema`	object	No	JSON Schema defining the structured output for functional agents
`enableToolSearch`	boolean	No	Enable semantic search to dynamically select relevant tools from a large action set
`enableCustomerMemory`Premium	boolean	No	Enable persistent customer memory across conversations
`enableSemanticRecall`Premium	boolean	No	Enable automatic surfacing of relevant past conversation snippets
`enableHumanHandoff`Premium	boolean	No	Enable human handoff for this agent
`agenticConfig`Premium	object	No	Agent Intelligence processor pipeline. Contains a `processors` array. See Processors for the full schema.
`profilePictureUrl`Premium	string	No	URL of the agent's avatar shown in the chat UI

Response

Returns 200 OK with the updated agent object.

json

{
  "id": "agent_xyz456",
  "name": "Support Assistant",
  "agentType": "conversational",
  "roleName": "assistant",
  "environmentId": "env_xyz789",
  "toolIds": ["action_abc123"],
  "mcpToolIds": [],
  "subAgentIds": [],
  "temperature": 0.5,
  "instructions": "You are a helpful customer support agent...",
  "createdAt": "2025-01-15T12:00:00Z"
}

Sample Request

bash

curl -X PUT "https://api.meebly.ai/v1/agent/agent_xyz456" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "environmentId": "env_xyz789",
    "temperature": 0.5,
    "instructions": "You are a helpful customer support agent. Be concise and friendly."
  }'

PreviousEdit Action

Last updated: March 2026Report an issue