PUT
/
agents
/
template
/
single-task
/
{agent_id}
Update Single Task Agent
curl --request PUT \
  --url https://agent-prod.studio.lyzr.ai/v3/agents/template/single-task/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "agent_role": "<string>",
  "agent_instructions": "<string>",
  "examples": "<string>",
  "features": [
    {
      "type": "<string>",
      "config": {},
      "priority": 123
    }
  ],
  "tool": "<string>",
  "tool_usage_description": "<string>",
  "llm_credential_id": "<string>",
  "provider_id": "<string>",
  "model": "<string>",
  "top_p": 123,
  "temperature": 123,
  "response_format": {}
}'
{
  "message": "Agent updated successfully."
}

​
Description

Updates an existing single-task agent with new configuration details.

​
Endpoint

PUT /v3/agents/template/single-task/{agent_id}

​
Authentication

  • Requires an API key (x-api-key) in the request headers.

​
Path Parameters

ParameterTypeDescription
agent_idstringUnique identifier of the single-task agent to update.

​
Request Body (JSON)

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agent_id
string
required

Unique identifier of the single-task agent to update.

Body

application/json

Response

200
application/json

Single-task agent updated successfully

The response is of type object.