Jump to

• Request
• Response

Get agents in schema

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents

Returns a list of agents in a schema.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Query Parameters

• computeKey: string
  Compute key.
• displayName: string
  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• displayNameContains: string
  Maximum Length: 1000

  A filter to return only resources that have a display name containing the text provided.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Maximum Length: 1024

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. List of agents in a schema is retrieved.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : AgentCollection

Type: object

Result of listing agents in a schema.

Show Source

• items(required): array items
  List of Agents.

{
    "type":"object",
    "description":"Result of listing agents in a schema.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of Agents.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AgentInfo"
            }
        }
    }
}

Nested Schema : items

Type: array

List of Agents.

Show Source

• Array of: object AgentInfo
  Summary information of agent in the schema.

{
    "description":"List of Agents.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AgentInfo"
    }
}

Nested Schema : AgentInfo

Type: object

Summary information of agent in the schema.

Show Source

• a2aEndpointUrl: string
  The A2A endpoint URL for the PROD deployment.
• computeKey: string
  Minimum Length: 1

  Maximum Length: 255

  The key of the agent compute associated with this agent.
• createdBy: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the user/principal who created the agent.
• dependenciesFilePath: string
  The path to dependencies file.
• deploymentComputeKey: string
  The key of the compute where agent is deployed.
• deploymentMode: string
  Agent deployment mode.
• deploymentState: object deploymentState
  Additional Properties Allowed: DeploymentLifecycleState

  The latest lifecycle states for the PROD and TEST deployment types.
• description: string
  Agent description.
• displayName(required): string
  Agent name.
• entryFilePath: string
  The path to project entry file.
• key(required): string
  The unique identifier (UUID) of the 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.
• lifecycleState: string
  The current state of the agent.
• pathInfo: string
  Path inside volume where the agent JSON is written.
• timeCreated: string(date-time)
  The date and time the agent was created.
• timeUpdated: string(date-time)
  The date and time the agent was updated.
• type: string
  Allowed Values: [ "CANVAS", "CODE" ]

  The type of agent (Canvas or Code).
• updatedBy: string
  Minimum Length: 1

  Maximum Length: 255

  The ID of the user who last updated the schema.
• uri: string
  Agent URI.
• uriState: string
  Agent URI state.
• workspaceKey: string
  The key of the workspace to which this agent belongs.

{
    "description":"Summary information of agent in the schema.",
    "type":"object",
    "required":[
        "key",
        "displayName"
    ],
    "properties":{
        "key":{
            "description":"The unique identifier (UUID) of the agent.",
            "type":"string"
        },
        "displayName":{
            "description":"Agent name.",
            "type":"string"
        },
        "description":{
            "description":"Agent description.",
            "type":"string"
        },
        "workspaceKey":{
            "description":"The key of the workspace to which this agent belongs.",
            "type":"string"
        },
        "pathInfo":{
            "description":"Path inside volume where the agent JSON is written.",
            "type":"string"
        },
        "type":{
            "description":"The type of agent (Canvas or Code).",
            "type":"string",
            "enum":[
                "CANVAS",
                "CODE"
            ]
        },
        "deploymentComputeKey":{
            "description":"The key of the compute where agent is deployed.",
            "type":"string"
        },
        "deploymentMode":{
            "description":"Agent deployment mode.",
            "type":"string"
        },
        "deploymentState":{
            "description":"The latest lifecycle states for the PROD and TEST deployment types.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/DeploymentLifecycleState"
            }
        },
        "uri":{
            "description":"Agent URI.",
            "type":"string"
        },
        "a2aEndpointUrl":{
            "description":"The A2A endpoint URL for the PROD deployment.",
            "type":"string"
        },
        "uriState":{
            "description":"Agent URI state.",
            "type":"string"
        },
        "entryFilePath":{
            "description":"The path to project entry file.",
            "type":"string"
        },
        "dependenciesFilePath":{
            "description":"The path to dependencies file.",
            "type":"string"
        },
        "lifecycleState":{
            "type":"string",
            "description":"The current state of the agent.",
            "x-obmcs-enumref":"#/definitions/Agent/lifecycleState"
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the agent in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n",
            "type":"string"
        },
        "computeKey":{
            "description":"The key of the agent compute associated with this agent.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "timeCreated":{
            "description":"The date and time the agent was created.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the agent was updated.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The OCID of the user/principal who created the agent.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "updatedBy":{
            "description":"The ID of the user who last updated the schema.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    }
}

Nested Schema : deploymentState

Type: object

Additional Properties Allowed

Show Source

• string
  Allowed Values: [ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ]

  LifecycleState of an Agent Session or Deployment.

{
    "description":"The latest lifecycle states for the PROD and TEST deployment types.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/DeploymentLifecycleState"
    }
}

The latest lifecycle states for the PROD and TEST deployment types.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top