Generate Agent Edit

POST 
/api/agents/generate-edit

This endpoint generates an updated agent configuration based on a description of desired changes and the current agent 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

description stringrequired

A detailed description of the changes to be made to the agent.

currentAgent

object

required

The current configuration of the agent to be modified.

rootAgentName string

The name of the agent.

displayprompt string

User-facing prompt template with parameter placeholders.

inputparameters object

Parameters that can be passed to the agent.

goal string

The primary goal of the agent.

description string

Detailed description of what the agent does.

stepsBreakdown object[]

Responses

200

Successfully generated updated agent configuration.

application/json

Schema

Schema

agentDetails

object

rootAgentName string

The name of the updated agent.

displayPrompt string

User-facing prompt template with parameter placeholders.

goal string

The primary goal of the agent.

description string

Detailed description of what the agent does.

stepsBreakdown

object[]

Array [

type string

The type of step (rag, compile, or structure).

prompt string

Detailed instructions for this step.

]

Example (from schema)

{
  "agentDetails": {
    "rootAgentName": "string",
    "displayPrompt": "string",
    "goal": "string",
    "description": "string",
    "stepsBreakdown": [
      {
        "type": "string",
        "prompt": "string"
      }
    ]
  }
}

400

Invalid request body or missing required fields.

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"
}

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 or error from language model service.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...