LiveCase

Pin the case to work on. Case-content tools operate on this case until select_case is called again. Reference tools such as get_template do not require a selected case. Call list_my_cases first if you do not have a case_id.

select_case

Create a new badge in this case study. Badges are used for branching logic and scoring. Returns the created badge with its ID. Operates only on the currently selected case.

Create a new character in this case study. Returns the created character with its ID. Operates only on the currently selected case.

Create a new characteristic (trait/metric) in this case study. Average characteristics require their scoring maximum in averageOutOf; sum characteristics are unbounded. Returns the created characteristic with its ID. Operates only on the currently selected case.

Create a validated chat in the current case. For an episode-type case, omit section_id because chats live directly on the series. For season/series cases, section_id must be the current episode ID (never a season ID). The server validates the type-specific data shape and referenced IDs, assigns nested IDs, and shifts following chats to preserve a unique contiguous order. Operates only on the currently selected case.

Create 1-100 validated chats in one call, in array order, with one save. All chats go into the same episode: omit section_id for episode cases; use an episode ID for season/series cases. Placement applies to the entire batch. If any chat or placement is invalid, nothing is saved. Uses the same type-specific validation, referenced IDs and nested ID generation as create_chat. Call lookup_chat_type for unfamiliar data shapes. Operates only on the currently selected case.

Create a new debrief in this case study. Debriefs are post-session review/reflection items. Returns the created debrief with its ID. Operates only on the currently selected case.

Create a new section in this case study. Returns the created section with its ID. Operates only on the currently selected case.

Delete a badge from this case study. This also removes the badge from any chats that reference it. Requires two calls: first without confirmed=true to get a confirmation prompt, then with confirmed=true to execute the deletion. Operates only on the currently selected case.

Delete a character from this case study. Requires two calls: first without confirmed=true to get a confirmation prompt, then with confirmed=true to execute the deletion. Operates only on the currently selected case.

Delete a characteristic from this case study. This also removes it from any chat answers that reference it. Requires two calls: first without confirmed=true to get a confirmation prompt, then with confirmed=true to execute the deletion. Operates only on the currently selected case.

Delete a chat item from this case study. Requires two calls: first without confirmed=true to get a confirmation prompt, then with confirmed=true to execute the deletion. Operates only on the currently selected case.

Delete a debrief from this case study. Requires two calls: first without confirmed=true to get a confirmation prompt, then with confirmed=true to execute the deletion. Operates only on the currently selected case.

Delete a section from this case study. This also removes all chats within the section. Requires two calls: first without confirmed=true to get a confirmation prompt, then with confirmed=true to execute the deletion. Operates only on the currently selected case.

Generate and save an image directly to this case. Targets: cover replaces the case cover; character replaces an existing character avatar; chat attaches to an existing image/context-image chat. Character avatars default to photorealistic human portraits unless the author explicitly requests another style; fictional characters alone do not imply cartoons. Covers follow packaging guidelines: one thematic focal point, contextual background, cinematic/photographic style, no text/logos/charts, simple at 256x256, not a centered headshot. Honor explicit author style choices. For a new image chat, create the chat first and then pass its returned ID here. Operates only on the currently selected case.

Get case files attached to this case study. Call with no arguments for a list, or with case_file_id to read a specific file's content. Operates only on the currently selected case.

Look up frequently asked questions and answers for the authoring interface. Use this when the user asks a how-to question, needs help with a feature, or seems confused about something. Available topics: -authoring-faq, basics, content, characters, badges, characteristics, marketing-/-metadata, visibility-&-publishing, advanced. Use 'all' to get everything. Operates only on the currently selected case.

Look up a static page reference with the UI layout, editable fields, and available actions for a specific page in the authoring interface. It does not contain live session values or current counts. Use this at most once when the user asks about what's on a page, where a field is, or what they can do on a specific page. Available pages: (basics): Basics, content: Content, characters: Characters, badges: Badges, characteristics: Characteristics, marketing: Marketing / Metadata, host: Host Settings, debrief: Debrief, visibility: Visibility, publishing: Publishing, advanced: Advanced Options, files: Files, stats: Statistics, pricing: Pricing, peer-review: Peer Review, validity: Validity Check Operates only on the currently selected case.

Get badges in this case study. Badges are used for branching logic and scoring. Call with no arguments for a list of all badges, or with badge_id for detailed info about a specific badge. Operates only on the currently selected case.

Get characteristics and their scoring scales. Always read averageOutOf/scoreScale before assigning characteristic values to question answers. Call with no arguments for all characteristics or with characteristic_id for one. Operates only on the currently selected case.

Get characters in this case study. Call with no arguments for a list of all characters, or with character_id for detailed info about a specific character. Operates only on the currently selected case.

Get chat items in the active chat container. Omit section_id for episode-type cases, where chats live directly on the series. For season/series cases, pass the episode section ID. Optionally pass chat_id for full type-specific data. Operates only on the currently selected case.

Get debriefs (post-section review/discussion items) in this case study. Call with no arguments for a list of all debriefs, or with debrief_id for detailed info about a specific debrief. Operates only on the currently selected case.

Get the current case type, basics, complete marketing metadata, AI authoring guide, and content counts. Operates only on the currently selected case.

Get sections (acts/chapters) of this case study. Call with no arguments for a list of all sections, or with section_id for detailed info about a specific section. Operates only on the currently selected case.

List every available chat type with its purpose and when to use it. Choose by learning objective and story need, then use lookup_chat_type for the exact payload. Operates only on the currently selected case.

Return the complete, creatable payload reference and exact validated data schema for one chat type. Exact IDs and common names are accepted; for example, 'allocation' and 'allocated balance' resolve to question-allocated-balance. Call this before creating or updating a chat whose shape is not known. Operates only on the currently selected case.

Search the LiveCase platform documentation for help articles and guides. Operates only on the currently selected case.

Update an existing badge in this case study. Provide the badge_id and any fields to update. Operates only on the currently selected case.

Update an existing character in this case study. Provide the character_id and any fields to update. Operates only on the currently selected case.

Update an existing characteristic in this case study. Provide the characteristic_id and any fields to update. Operates only on the currently selected case.

Update a validated existing chat without losing untouched fields. `data` is the complete replacement type-specific payload. Reposition with position/after_chat_id/before_chat_id; following chats are reindexed. For episode-type cases section_id is omitted; for season/series it may move the chat to another episode. Operates only on the currently selected case.

Update an existing debrief in this case study. Provide the debrief_id and any fields to update. Operates only on the currently selected case.

Update an existing section in this case study. Provide the section_id and any fields to update. Operates only on the currently selected case.

Update case basics, marketing metadata for hosts and players, teaching notes, or AI authoring guidance. Only supplied fields change. Use generate_image separately to replace the cover image. Operates only on the currently selected case.