Jump to

• Request
• Response

Get Agent Session details

get

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

Returns detailed information about an Agent Session.

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

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

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : AgentSession

Type: object

Agent session.

Show Source

• agentComputeKey(required): string
  The Agent Compute Key where client can run or test the agent.
• agentKey(required): string
  The Agent key for which the session is started.
• context: object AgentSessionContext
  Agent session context.
• createdBy: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the user/principal who created the agent session.
• displayName(required): string
  Display name.
• endpointUrl(required): string
  The endpointUrl where the client should connect to communicate with the agent.
• key(required): string
  Agent Session identifier.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ]

  LifecycleState of an Agent Session or Deployment.
• timeCreated: string(date-time)
  The date and time the Agent session was created.
• timeEnded: string(date-time)
  The date and time the session was ended.
• timeStarted: string(date-time)
  The date and time the session was started.
• timeUpdated: string(date-time)
  The date and time the Agent session was updated.
• updatedBy: string
  OCID of the user who updated this record

{
    "description":"Agent session.",
    "type":"object",
    "required":[
        "displayName",
        "key",
        "agentKey",
        "endpointUrl",
        "lifecycleState",
        "agentComputeKey"
    ],
    "properties":{
        "displayName":{
            "description":"Display name.",
            "type":"string"
        },
        "key":{
            "description":"Agent Session identifier.",
            "type":"string"
        },
        "agentKey":{
            "description":"The Agent key for which the session is started.",
            "type":"string"
        },
        "endpointUrl":{
            "description":"The endpointUrl where the client should connect to communicate with the agent.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"LifecycleState of an Agent Session or Deployment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState",
            "enum":[
                "CREATING",
                "ACTIVE",
                "INACTIVE",
                "FAILED",
                "DELETED"
            ]
        },
        "agentComputeKey":{
            "description":"The Agent Compute Key where client can run or test the agent.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the Agent session was created.",
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "description":"OCID of the user who updated this record",
            "type":"string"
        },
        "createdBy":{
            "description":"The OCID of the user/principal who created the agent session.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "timeUpdated":{
            "description":"The date and time the Agent session was updated.",
            "type":"string",
            "format":"date-time"
        },
        "timeStarted":{
            "description":"The date and time the session was started.",
            "type":"string",
            "format":"date-time"
        },
        "timeEnded":{
            "description":"The date and time the session was ended.",
            "type":"string",
            "format":"date-time"
        },
        "context":{
            "$ref":"#/definitions/AgentSessionContext"
        }
    }
}

Nested Schema : AgentSessionContext

Type: object

Agent session context.

Show Source

• retentionConfig: object SessionRetentionConfiguration
  Session data retention configuration for an Agent.

{
    "description":"Agent session context.",
    "type":"object",
    "properties":{
        "retentionConfig":{
            "$ref":"#/definitions/SessionRetentionConfiguration"
        }
    }
}

Nested Schema : SessionRetentionConfiguration

Type: object

Session data retention configuration for an Agent.

Show Source

• retentionPeriodInDays: integer
  Minimum Value: 1

  No. of days session data will be kept
• sessionSizeLimit: integer
  Minimum Value: 1

  Max storage allocated to session data (in MB).
• threadCountLimit: integer
  Minimum Value: 1

  Maximum no. of user prompt and agent response pairs per session

{
    "description":"Session data retention configuration for an Agent.",
    "type":"object",
    "properties":{
        "retentionPeriodInDays":{
            "description":"No. of days session data will be kept",
            "type":"integer",
            "minimum":1
        },
        "sessionSizeLimit":{
            "description":"Max storage allocated to session data (in MB).",
            "type":"integer",
            "minimum":1
        },
        "threadCountLimit":{
            "description":"Maximum no. of user prompt and agent response pairs per session",
            "type":"integer",
            "minimum":1
        }
    }
}

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