Generate Summary

Return a generative AI summarization of the specified session using the supplied prompt summary profile that specifies both prompting instructions and session context configuration.

See the Generate Summary Overview section of the Introduction for detailed guidance on generating session summaries.

This functionality is a part of Anywhere: Activation. To learn more about Fullstory Anywhere, please visit this page.

Path Parameters

session_id string required

The UTF-8 encoded ID of the session for which to generate context data. To retrieve the Session ID you may use the appropriate Get Session Details API for Web, iOS, or Android. As Session IDs include : separators the ID must be URL encoded using the %3A substitution. Learn more.

Query Parameters

config_profile string optional

The id value returned from Create Profile.

Responses

200

---

Text based output of the Generative AI response based on the specified Profile.

Schema

Example

---

Schema

summary string optional
response object optional
response_schema object optional
Echoes the structured response schema used, enabling clients to validate/interpret the dynamic response map.
type string optional
Possible values: [OPENAPI_TYPE_UNSPECIFIED, STRING, NUMBER, INTEGER, BOOLEAN, ARRAY, OBJECT]
Default value: OPENAPI_TYPE_UNSPECIFIED
title string optional
description string optional
items object optional
0 optional
1 optional
2 optional
3 optional
4 optional
5 optional
6 optional
7 optional
8 optional
9 optional
10 optional
11 optional
12 optional
13 optional
14 optional
15 optional
16 optional
17 optional
18 optional
19 optional
20 optional
21 optional
22 optional
23 optional
24 optional
properties object optional
property name* object optional
0 optional
1 optional
2 optional
3 optional
4 optional
5 optional
6 optional
7 optional
8 optional
9 optional
10 optional
11 optional
12 optional
13 optional
14 optional
15 optional
16 optional
17 optional
18 optional
19 optional
20 optional
21 optional
22 optional
23 optional
24 optional
required string[] optional
nullable boolean optional
enum string[] optional
format string optional

{
  "response": {},
  "response_schema": {
    "type": "OBJECT",
    "title": "SessionSummary",
    "description": "Structured output for the LLM response",
    "properties": {
      "summary": {
        "type": "STRING",
        "description": "Concise session summary"
      },
      "sentiment": {
        "type": "STRING",
        "enum": [
          "positive",
          "neutral",
          "negative"
        ],
        "format": "enum"
      },
      "issues": {
        "type": "ARRAY",
        "items": {
          "type": "STRING"
        }
      }
    },
    "required": [
      "summary"
    ]
  }
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

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

Example

---

Schema

message string required

Long form description of what went wrong

code string required

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

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

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

Example

---

Schema

message string required

Long form description of what went wrong

code string required

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

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Loading...