Jump to

• Request
• Response

Get Agent Session trace for a given message key

get

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

Returns trace details for a given message key.

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
• traceKey(required): string
  A filter to return only resources that match the given display trace key exactly.
• 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

• 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 : TraceDetails

Type: object

Trace object

Show Source

• endTime(required): integer(int64)
  endTime
• parentSessionId(required): string
  session id
• resources: object resources
  Additional Properties Allowed: additionalProperties

  Map of properties
• spans(required): array spans
  collections of spans
• startTime(required): integer(int64)
  startTime
• traceId(required): string
  trace id

{
    "type":"object",
    "description":"Trace object",
    "properties":{
        "traceId":{
            "type":"string",
            "description":"trace id"
        },
        "parentSessionId":{
            "type":"string",
            "description":"session id"
        },
        "spans":{
            "type":"array",
            "description":"collections of spans",
            "items":{
                "$ref":"#/definitions/SpanDetails"
            }
        },
        "startTime":{
            "type":"integer",
            "format":"int64",
            "description":"startTime"
        },
        "endTime":{
            "type":"integer",
            "format":"int64",
            "description":"endTime"
        },
        "resources":{
            "type":"object",
            "description":"Map of properties",
            "additionalProperties":{
                "type":"object"
            }
        }
    },
    "required":[
        "traceId",
        "parentSessionId",
        "startTime",
        "endTime",
        "spans"
    ]
}

Nested Schema : resources

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Map of properties",
    "additionalProperties":{
        "type":"object"
    }
}

Map of properties

Nested Schema : spans

Type: array

collections of spans

Show Source

• Array of: object SpanDetails
  Span details

{
    "type":"array",
    "description":"collections of spans",
    "items":{
        "$ref":"#/definitions/SpanDetails"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : SpanDetails

Type: object

Span details

Show Source

• attributes(required): object attributes
  Additional Properties Allowed: additionalProperties

  span attributes
• endTime(required): integer(int64)
  end time
• events(required): array events
  collections of trace objects
• kind(required): string
  type of span
• parentSpanId: string
  parent span id
• parentTraceId(required): string
  trace id
• spanId(required): string
  span id
• spanName(required): string
  span name
• startTime(required): integer(int64)
  start time
• status(required): object SpanStatus
  span status

{
    "type":"object",
    "description":"Span details",
    "properties":{
        "parentTraceId":{
            "type":"string",
            "description":"trace id"
        },
        "spanId":{
            "type":"string",
            "description":"span id"
        },
        "parentSpanId":{
            "type":"string",
            "description":"parent span id"
        },
        "startTime":{
            "type":"integer",
            "format":"int64",
            "description":"start time"
        },
        "endTime":{
            "type":"integer",
            "format":"int64",
            "description":"end time"
        },
        "kind":{
            "type":"string",
            "description":"type of span"
        },
        "spanName":{
            "type":"string",
            "description":"span name"
        },
        "attributes":{
            "type":"object",
            "description":"span attributes",
            "additionalProperties":{
                "type":"object"
            }
        },
        "events":{
            "type":"array",
            "description":"collections of trace objects",
            "items":{
                "$ref":"#/definitions/TraceEvent"
            }
        },
        "status":{
            "$ref":"#/definitions/SpanStatus"
        }
    },
    "required":[
        "parentTraceId",
        "spanId",
        "startTime",
        "endTime",
        "kind",
        "spanName",
        "attributes",
        "events",
        "status"
    ]
}

Nested Schema : attributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"span attributes",
    "additionalProperties":{
        "type":"object"
    }
}

span attributes

Nested Schema : events

Type: array

collections of trace objects

Show Source

• Array of: object TraceEvent
  event object details

{
    "type":"array",
    "description":"collections of trace objects",
    "items":{
        "$ref":"#/definitions/TraceEvent"
    }
}

Nested Schema : SpanStatus

Type: object

span status

Show Source

• code: string
  span status code
• message: string
  span message

{
    "type":"object",
    "description":"span status",
    "properties":{
        "code":{
            "type":"string",
            "description":"span status code"
        },
        "message":{
            "type":"string",
            "description":"span message"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : TraceEvent

Type: object

event object details

Show Source

• attributes: object attributes
  Additional Properties Allowed: additionalProperties

  event attributes
• name: string
  event name
• timestamp: string(date-time)
  event start time

{
    "type":"object",
    "description":"event object details",
    "properties":{
        "name":{
            "type":"string",
            "description":"event name"
        },
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"event start time"
        },
        "attributes":{
            "type":"object",
            "description":"event attributes",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : attributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"event attributes",
    "additionalProperties":{
        "type":"object"
    }
}

event attributes

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