Jump to

• Request
• Response

Get Agent Session chat messages

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/sessions/{sessionId}/chatHistory

Returns list of Agent Session chat messages.

Request

Path Parameters

• agentKey(required): string
  The UUID of the Agent
• 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.
• sessionId(required): string
  The UUID of the Agent Session
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Query Parameters

• 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).

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

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

Type: object

A paginated collection of chat messages.

Show Source

• items(required): array items
  Collection of chat messages

{
    "type":"object",
    "description":"A paginated collection of chat messages.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of chat messages",
            "items":{
                "$ref":"#/definitions/SessionChatHistorySummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Collection of chat messages

Show Source

• Array of: object SessionChatHistorySummary
  A single message in a chat session history. Does not include internal state.

{
    "type":"array",
    "description":"Collection of chat messages",
    "items":{
        "$ref":"#/definitions/SessionChatHistorySummary"
    }
}

Nested Schema : SessionChatHistorySummary

Type: object

A single message in a chat session history. Does not include internal state.

Show Source

• content(required): array content
  Message content.
• key(required): string
  Unique identifier for the message.
• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  Optional key-value metadata associated with the message
• role(required): string
  Role associated with the message, such as user, assistant, system, or tool.
• sessionKey(required): string
  Identifier of the chat session this message belongs to.
• timeCreated(required): string(date-time)
  Time the message was created.
• toolCallId: string
  Identifier of the tool call, if applicable.
• toolName: string
  Name of the tool, if this is a tool message.

{
    "type":"object",
    "description":"A single message in a chat session history. Does not include internal state.",
    "required":[
        "key",
        "sessionKey",
        "role",
        "content",
        "timeCreated"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Unique identifier for the message."
        },
        "sessionKey":{
            "type":"string",
            "description":"Identifier of the chat session this message belongs to."
        },
        "role":{
            "type":"string",
            "description":"Role associated with the message, such as user, assistant, system, or tool."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time the message was created."
        },
        "content":{
            "type":"array",
            "description":"Message content.",
            "items":{
                "$ref":"#/definitions/ChatMessage"
            }
        },
        "toolName":{
            "type":"string",
            "description":"Name of the tool, if this is a tool message."
        },
        "toolCallId":{
            "type":"string",
            "description":"Identifier of the tool call, if applicable."
        },
        "metadata":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            },
            "description":"Optional key-value metadata associated with the message"
        }
    }
}

Nested Schema : content

Type: array

Message content.

Show Source

• Array of: object ChatMessage
  The content of the chat query sent by the user.

{
    "type":"array",
    "description":"Message content.",
    "items":{
        "$ref":"#/definitions/ChatMessage"
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    },
    "description":"Optional key-value metadata associated with the message"
}

Optional key-value metadata associated with the message

Nested Schema : ChatMessage

Type: object

The content of the chat query sent by the user.

Show Source

• fileUrl: string
  File URL for the image user intends to query. Set this parameter when type is input_file.
• imageUrl: string
  Image URL for the image user intends to query. Set this parameter when type is input_image.
• text: string
  Maximum Length: 1048576

  Text input from the user. Set this parameter when type is input_text.
• type(required): string
  Allowed Values: [ "INPUT_TEXT", "INPUT_IMAGE", "INPUT_FILE" ]

  Type of input.

{
    "description":"The content of the chat query sent by the user.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of input.",
            "type":"string",
            "enum":[
                "INPUT_TEXT",
                "INPUT_IMAGE",
                "INPUT_FILE"
            ]
        },
        "text":{
            "description":"Text input from the user. Set this parameter when type is input_text.",
            "type":"string",
            "maxLength":1048576
        },
        "imageUrl":{
            "description":"Image URL for the image user intends to query. Set this parameter when type is input_image.",
            "type":"string"
        },
        "fileUrl":{
            "description":"File URL for the image user intends to query. Set this parameter when type is input_file.",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

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

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