Jump to

• Request
• Response
• Examples

Retrieve an AI Agent in a Project

get

/ic/api/integration/v1/projects/{projectId}/ai/agents/{id}

Fetches details of a specific AI Agent.

Request

Path Parameters

• id(required): string
  AI Agent identifier
• projectId(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• allOf AIAgentListRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AIAgentListRs"
        },
        {
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"Description"
                },
                "guidelines":{
                    "type":"string",
                    "description":"AI Guidelines"
                },
                "role":{
                    "type":"string",
                    "description":"Agent role"
                },
                "dependencies":{
                    "$ref":"#/components/schemas/AIAgentResourceDependencyRs",
                    "description":"Associated resources"
                },
                "endpointURI":{
                    "type":"string",
                    "description":"Endpoint URI used to invoke agent"
                }
            }
        }
    ]
}

Nested Schema : AIAgentListRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object AIAgentListRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"AI Agent name"
                },
                "code":{
                    "type":"string",
                    "description":"AI Agent code"
                },
                "version":{
                    "type":"string",
                    "description":"AI Agent version"
                },
                "status":{
                    "type":"string",
                    "description":"AI Agent Status"
                },
                "description":{
                    "type":"string",
                    "description":"AI Agent description"
                },
                "projectId":{
                    "type":"string",
                    "description":"Project id which agent is part of"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Created"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Created By"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Last Updated By"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Last Updated"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : AIAgentListRs-allOf[2]

Type: object

Show Source

• code: string
  AI Agent code
• created: string (date-time)
  Created
• createdBy: string
  Created By
• description: string
  AI Agent description
• lastUpdated: string (date-time)
  Last Updated
• lastUpdatedBy: string
  Last Updated By
• name: string
  AI Agent name
• projectId: string
  Project id which agent is part of
• status: string
  AI Agent Status
• version: string
  AI Agent version

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"AI Agent name"
        },
        "code":{
            "type":"string",
            "description":"AI Agent code"
        },
        "version":{
            "type":"string",
            "description":"AI Agent version"
        },
        "status":{
            "type":"string",
            "description":"AI Agent Status"
        },
        "description":{
            "type":"string",
            "description":"AI Agent description"
        },
        "projectId":{
            "type":"string",
            "description":"Project id which agent is part of"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Created"
        },
        "createdBy":{
            "type":"string",
            "description":"Created By"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Last Updated By"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Last Updated"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• dependencies: object AIAgentResourceDependencyRs
• description: string
  Description
• endpointURI: string
  Endpoint URI used to invoke agent
• guidelines: string
  AI Guidelines
• role: string
  Agent role

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description"
        },
        "guidelines":{
            "type":"string",
            "description":"AI Guidelines"
        },
        "role":{
            "type":"string",
            "description":"Agent role"
        },
        "dependencies":{
            "$ref":"#/components/schemas/AIAgentResourceDependencyRs",
            "description":"Associated resources"
        },
        "endpointURI":{
            "type":"string",
            "description":"Endpoint URI used to invoke agent"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : AIAgentResourceDependencyRs

Type: object

Show Source

• templates: array templates
• thinkingPattern: object PatternDependencyRs
• tools: array tools

{
    "type":"object",
    "properties":{
        "thinkingPattern":{
            "$ref":"#/components/schemas/PatternDependencyRs"
        },
        "tools":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ToolDependencyRs"
            }
        },
        "templates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TemplateDependencyRs"
            }
        }
    }
}

Nested Schema : templates

Type: array

Show Source

• Array of: object TemplateDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TemplateDependencyRs"
    }
}

Nested Schema : PatternDependencyRs

Type: object

Show Source

• description: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : tools

Type: array

Show Source

• Array of: object ToolDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ToolDependencyRs"
    }
}

Nested Schema : TemplateDependencyRs

Type: object

Show Source

• description: string
• id: string
• isPrimary: boolean
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isPrimary":{
            "type":"boolean"
        }
    }
}

Nested Schema : ToolDependencyRs

Type: object

Show Source

• description: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

404 Response

AI Agent not found

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve a specific AI Agent by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve AI Agent ORDER_AGENT in project TEST_PROJECT

This command retrieves the specified AI Agent. The id is in the form: code%7Cversion.

The %7C is the encoded | (vertical line).

curl -X GET -H 'Authorization: Bearer access_token' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/agents/ORDER_AGENT%7C01.00.0000?integrationInstance=service-instance

Back to Top