oci_generative_ai_agent_agent

This resource provides the Agent resource in Oracle Cloud Infrastructure Generative Ai Agent service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/generative-ai-agents/latest/Agent

Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/generative_ai_agent

Creates an agent.

Example Usage

resource "oci_generative_ai_agent_agent" "test_agent" {
	#Required
	compartment_id = var.compartment_id

	#Optional
	defined_tags = {"Operations.CostCenter"= "42"}
	description = var.agent_description
	display_name = var.agent_display_name
	freeform_tags = {"Department"= "Finance"}
	knowledge_base_ids = var.agent_knowledge_base_ids
	llm_config {

		#Optional
		routing_llm_customization {

			#Optional
			instruction = var.agent_llm_config_routing_llm_customization_instruction
		}
	}
	welcome_message = var.agent_welcome_message
}

Argument Reference

The following arguments are supported:

• compartment_id - (Required) (Updatable) The OCID of the compartment to create the agent in.
• defined_tags - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
• description - (Optional) (Updatable) Description about the agent.
• display_name - (Optional) (Updatable) A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
• freeform_tags - (Optional) (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
• knowledge_base_ids - (Optional) (Updatable) List of OCID of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026.
• llm_config - (Optional) (Updatable) Configuration to Agent LLM.
  • routing_llm_customization - (Optional) (Updatable) Configuration to customize LLM.
    • instruction - (Optional) (Updatable) If specified, the default instruction is replaced with provided instruction.
• welcome_message - (Optional) (Updatable) Details about purpose and responsibility of the agent

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Attributes Reference

The following attributes are exported:

• compartment_id - The OCID of the compartment.
• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
• description - Description about the agent.
• display_name - A user-friendly name. Does not have to be unique, and it’s changeable.
• freeform_tags - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
• id - The OCID of the agent.
• knowledge_base_ids - List of OCID of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026.
• lifecycle_details - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
• llm_config - Configuration to Agent LLM.
  • routing_llm_customization - Configuration to customize LLM.
    • instruction - If specified, the default instruction is replaced with provided instruction.
• state - The current state of the agent.
• system_tags - System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
• time_created - The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
• time_updated - The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
• welcome_message - Details about purpose and responsibility of the agent

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Agent * update - (Defaults to 20 minutes), when updating the Agent * delete - (Defaults to 20 minutes), when destroying the Agent

Import

Agents can be imported using the id, e.g.

$ terraform import oci_generative_ai_agent_agent.test_agent "id"