oci.GenerativeAi.getAgentAgent (v2)

Oracle Cloud Infrastructure v2.33.0 (2.x), Mar 9 26

Viewing docs for Oracle Cloud Infrastructure v2.33.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v2.33.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-oci

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAgent = oci.GenerativeAi.getAgentAgent({
    agentId: testAgentOciGenerativeAiAgentAgent.id,
});

import pulumi
import pulumi_oci as oci

test_agent = oci.GenerativeAi.get_agent_agent(agent_id=test_agent_oci_generative_ai_agent_agent["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.GetAgentAgent(ctx, &generativeai.GetAgentAgentArgs{
			AgentId: testAgentOciGenerativeAiAgentAgent.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAgent = Oci.GenerativeAi.GetAgentAgent.Invoke(new()
    {
        AgentId = testAgentOciGenerativeAiAgentAgent.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentAgentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testAgent = GenerativeAiFunctions.getAgentAgent(GetAgentAgentArgs.builder()
            .agentId(testAgentOciGenerativeAiAgentAgent.id())
            .build());

    }
}

variables:
  testAgent:
    fn::invoke:
      function: oci:GenerativeAi:getAgentAgent
      arguments:
        agentId: ${testAgentOciGenerativeAiAgentAgent.id}

Using getAgentAgent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgentAgent(args: GetAgentAgentArgs, opts?: InvokeOptions): Promise<GetAgentAgentResult>
function getAgentAgentOutput(args: GetAgentAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentAgentResult>

def get_agent_agent(agent_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAgentAgentResult
def get_agent_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAgentAgentResult]

func LookupAgentAgent(ctx *Context, args *LookupAgentAgentArgs, opts ...InvokeOption) (*LookupAgentAgentResult, error)
func LookupAgentAgentOutput(ctx *Context, args *LookupAgentAgentOutputArgs, opts ...InvokeOption) LookupAgentAgentResultOutput

> Note: This function is named LookupAgentAgent in the Go SDK.

public static class GetAgentAgent 
{
    public static Task<GetAgentAgentResult> InvokeAsync(GetAgentAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentAgentResult> Invoke(GetAgentAgentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAgentAgentResult> getAgentAgent(GetAgentAgentArgs args, InvokeOptions options)
public static Output<GetAgentAgentResult> getAgentAgent(GetAgentAgentArgs args, InvokeOptions options)

fn::invoke:
  function: oci:GenerativeAi/getAgentAgent:getAgentAgent
  arguments:
    # arguments dictionary

The following arguments are supported:

AgentId string: The OCID of the agent.

AgentId string: The OCID of the agent.

agentId String: The OCID of the agent.

agentId string: The OCID of the agent.

agent_id str: The OCID of the agent.

agentId String: The OCID of the agent.

getAgentAgent Result

The following output properties are available:

AgentId string
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, string>: 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 string: Description about the agent.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
FreeformTags Dictionary<string, string>: 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 string: The OCID of the agent.
KnowledgeBaseIds List<string>: List of OCID of the knowledgeBases associated with agent.
LifecycleDetails string: 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.
State string: The current state of the agent.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
WelcomeMessage string: Details about purpose and responsibility of the agent

AgentId string
CompartmentId string: The OCID of the compartment.
DefinedTags map[string]string: 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 string: Description about the agent.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable.
FreeformTags map[string]string: 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 string: The OCID of the agent.
KnowledgeBaseIds []string: List of OCID of the knowledgeBases associated with agent.
LifecycleDetails string: 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.
State string: The current state of the agent.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
TimeUpdated string: The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
WelcomeMessage string: Details about purpose and responsibility of the agent

agentId String
compartmentId String: The OCID of the compartment.
definedTags Map<String,String>: 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 String: Description about the agent.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
freeformTags Map<String,String>: 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 String: The OCID of the agent.
knowledgeBaseIds List<String>: List of OCID of the knowledgeBases associated with agent.
lifecycleDetails String: 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.
state String: The current state of the agent.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcomeMessage String: Details about purpose and responsibility of the agent

agentId string
compartmentId string: The OCID of the compartment.
definedTags {[key: string]: string}: 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 string: Description about the agent.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable.
freeformTags {[key: string]: string}: 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 string: The OCID of the agent.
knowledgeBaseIds string[]: List of OCID of the knowledgeBases associated with agent.
lifecycleDetails string: 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.
state string: The current state of the agent.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated string: The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcomeMessage string: Details about purpose and responsibility of the agent

agent_id str
compartment_id str: The OCID of the compartment.
defined_tags Mapping[str, str]: 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 str: Description about the agent.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable.
freeform_tags Mapping[str, str]: 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 str: The OCID of the agent.
knowledge_base_ids Sequence[str]: List of OCID of the knowledgeBases associated with agent.
lifecycle_details str: 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.
state str: The current state of the agent.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
time_updated str: The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcome_message str: Details about purpose and responsibility of the agent

agentId String
compartmentId String: The OCID of the compartment.
definedTags Map<String>: 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 String: Description about the agent.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable.
freeformTags Map<String>: 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 String: The OCID of the agent.
knowledgeBaseIds List<String>: List of OCID of the knowledgeBases associated with agent.
lifecycleDetails String: 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.
state String: The current state of the agent.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the agent was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
timeUpdated String: The date and time the agent was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
welcomeMessage String: Details about purpose and responsibility of the agent