Type Alias Agent

Agent: {
    base_agent?: string;
    base_environment?: Environment | string;
    description?: string;
    id?: string;
    system_instruction?: string;
    tools?: AgentTool[];
}

An agent definition for the CreateAgent API.

Type declaration

  • Optionalbase_agent?: string

    The base agent to extend.

  • Optionalbase_environment?: Environment | string

    The environment configuration for the agent.

  • Optionaldescription?: string

    Agent description for developers to quickly read and understand.

  • Optionalid?: string

    The unique identifier for the agent.

  • Optionalsystem_instruction?: string

    System instruction for the agent.

  • Optionaltools?: AgentTool[]

    The tools available to the agent.

Remarks

This message is the target for annotation-parser-based JSON parsing. New format: { "id": "customer-sentinel", "base_agent": "", "system_instruction": "...", "base_environment": { "type": "remote", "sources": [...] }, "tools": [ {"type": "code_execution"} ] }

Settings