Generate Agent Configuration

POST 
/api/agents/generate

This endpoint generates an agent configuration based on a provided description. 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 agent's purpose and functionality.

Responses

200

Successfully generated agent configuration.

application/json

Schema

Schema

agentDetails

object

rootAgentName string

The name of the generated 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 description.

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

error

object

message string

Detailed error message indicating authentication failure.

Example (from schema)

{
  "error": {
    "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...