Jump to

• Request
• Response
• Examples

Retrieve AI Agents in a Project

get

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

Returns all AI Agents defined in the project.

Request

Path Parameters

• 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.
• limit: integer(int32)
  Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list AI Agents starting at the 4th item, and the list will contain 16 items.
• offset: integer(int32)
  Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list AI Agents starting at the 4th item, and the list will contain 16 items.
• orderBy: string

  Lists AI Agents ordered by name, last updated time.

  Valid values:

  • name: Order AI Agents by name. Example: orderBy=name.
  • time: Order AI Agent by the last updated time. Example: orderBy=time.
• q: string

  Filters AI Agents by name and status.

  Valid parameters:

  • name: Name of the AI Agent. For example:
    • To retrieve all AI Agents that contain the specified string in the name, specify:

      q={name: /ORDER/}

  • status: Status of AI Agent. Valid statuses are INPROGRESS, CONFIGURED, ACTIVATION_INPROGRESS, ACTIVATED, and FAILEDACTIVATION.

    For example, to retrieve all AI Agents that contain ORDER and have the status ACTIVATED, specify:

    {name : /ORDER/, status : 'ACTIVATED'}

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=collection

200 Response

Successful operation

Body ()

Root Schema : AIAgentsRs

Match All

Show Source

• object GenericRestRs
• object AIAgentsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"List of Agents",
                    "items":{
                        "$ref":"#/components/schemas/AIAgentListRs"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Total Results"
                },
                "hasMore":{
                    "type":"boolean",
                    "description":"Flag to Check if More Records Exists"
                },
                "limit":{
                    "type":"integer",
                    "format":"int32",
                    "description":"Limit of Records to be Displayed"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : AIAgentsRs-allOf[1]

Type: object

Show Source

• hasMore: boolean
  Flag to Check if More Records Exists
• items: array items
  List of Agents
• limit: integer (int32)
  Limit of Records to be Displayed
• totalResults: integer (int32)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Agents",
            "items":{
                "$ref":"#/components/schemas/AIAgentListRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total Results"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Limit of Records to be Displayed"
        }
    }
}

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 : items

Type: array

List of Agents

Show Source

• Array of: AIAgentListRs

{
    "type":"array",
    "description":"List of Agents",
    "items":{
        "$ref":"#/components/schemas/AIAgentListRs"
    }
}

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 : 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"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve all AI Agents defined in a project 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 agents in project TEST_PROJECT

This command retrieves all AI Agents defined in the specified project.

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

Example: Retrieve active AI agents in a project

This command retrieves AI Agents in the specified project whose name contains ORDER and whose status is ACTIVATED. The results are sorted by name and limited to 10 records.

curl -X GET -H 'Authorization: Bearer access_token' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/ai/agents?q={name:/ORDER/,status:'ACTIVATED'}&orderBy=name&offset=0&limit=10&integrationInstance=service-instance

Back to Top