Get Profile
Return the summarization Profile that specifies both prompting instructions and session context configuration.
Path Parameters
Client defined ID representing this profile to be used in profile management API calls and to specify when performing session analysis.
A successful response.
Schema
Client defined ID representing this profile to be used in profile management API calls and to specify when performing session analysis.
configuration object optional
Configuration used to customize session context presented to Generativev AI for analysis.
Text to be included in the Generative AI prompt before including the contextual representation of the requested session.
Text to be included in the Generative AI prompt before including the contextual representation of the requested session.
JSON schema to provide to Generative AI for formatting of result and to be used to validate the proper output format.
Possible values: [GEMINI_2_FLASH
, GEMINI_2_FLASH_LITE
]
Generative AI large language model to use.
Controls the randomness of text generated by a large language model.
{
"configuration": {
"exclude_event_types": [
null
],
"include_event_types": [
null
],
"screenshot_event_types": [
null
]
},
"model": "INVALID"
}
Returned when invalid input has been provided. Fix the issue and retry.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "session_id is required",
"code": "required_field"
}
Returned when access to the resource is unauthorized.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "access is unauthorized",
"code": "unauthorized"
}
Returned when access is not allowed due to insufficient permissions.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "insufficient permissions",
"code": "forbidden"
}
Returned when the resource does not exist.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Requested resource does not exist",
"code": "resource_not_found"
}
Returned when the client has exceeded the rate limit for this endpoint. A Retry-After
header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
"code": "too_many_requests"
}
Returned when a server error is encountered.
Schema
Long form description of what went wrong
A short snake-cased value that is safe to handle programmatically
{
"message": "Server error was encountered",
"code": "server_error"
}