Edit Existing Agent

PUT 
/api/agents/edit

This endpoint updates an existing agent with the provided configuration. The request must include a valid API key and user ID.

Request

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

application/json

Body

required

agentId stringrequired

The unique identifier of the agent to update.

rootAgentName stringrequired

The name of the agent.

displayprompt stringrequired

User-facing prompt template with parameter placeholders.

inputparameters object

Parameters that can be passed to the agent.

goal stringrequired

The primary goal of the agent.

description stringrequired

Detailed description of what the agent does.

stepsBreakdown

object[]

required

Array [

type string

Type of step (rag, compile, or structure).

prompt string

Detailed instructions for this step.

agentname string

Name of the agent handling this step.

content

object

query string

Instructions for this step.

response stringnullable

Response from this step.

external string

External source used for this step.

]

Responses

200

Successfully updated the agent.

application/json

Schema

Schema

message object

Response message containing the updated agent details.

Example (from schema)

{
  "message": {}
}

400

Invalid request body or missing agent ID.

application/json

Schema

Schema

message string

Error message indicating the issue with the request.

Example (from schema)

{
  "message": "string"
}

403

Invalid API key or authentication failed.

application/json

Schema

Schema

message string

Detailed error message indicating authentication failure.

Example (from schema)

{
  "message": "string"
}

404

Agent not found.

application/json

Schema

Schema

message string

Error message indicating that the agent was not found.

Example (from schema)

{
  "message": "string"
}

405

Method not allowed.

application/json

Schema

Schema

message string

Error message indicating that the method is not allowed.

Example (from schema)

{
  "message": "string"
}

500

Internal server error.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...