Changelog

​

v1.44.1

​

Features

• Chat Feedback Context API
  • Added client.v1.chat.retrieveFeedbackContext() method to retrieve specific message and full conversation for a feedback item
  • Retrieves complete conversation context for analyzing user feedback
  • Accepts feedbackId parameter to identify the specific feedback item
  • See documentation
  • Related: v1.44.0 includes Chat Feedback Analytics and Embed Context features

​

v1.44.0

​

Features

• Chat Embed Context Management
  • Added context API for pushing dynamic context to embedded chat components
  • New client.v1.embed.context.push() method to add context strings to specific embed instances
  • New client.v1.embed.context.retrieve() method to get current context for an embed
  • New client.v1.embed.context.clear() method to clear context from an embed
  • Enables dynamic content updates (e.g., question changes in practice tests) without losing chat history
  • See documentation
• Chat Feedback Analytics
  • Added client.v1.chat.retrieveFeedback() method to retrieve user feedback data
  • Support for filtering feedback by component ID, user ID, date range, and feedback type
  • Feedback type options: thumbsUp and thumbsDown
  • See documentation
• Chat Component Configuration
  • Added enableFeedback option (default: true) to enable/disable thumbs up/down feedback with reason
• API Updates
  • Enhanced embed service with context management capabilities
  • Updated type definitions and method signatures

​

v1.43.0

​

Features

• API Updates
  • Added PDF Generator service for creating presentations
  • Added studentName parameter to component embedding
  • Updated API contracts and type definitions
• Chat Component Enhancements
  • Added hideTitle configuration option to hide chat component headings (icon and title)
  • Added hideEmptyState option to hide default empty state UI
  • Added support for custom HTML to replace the default icon and message when chat is empty via emptyStateHTML
  • Removed user avatar from chat interface for cleaner UI
  • Removed Spark.E references from prompt guidance system

​

v1.42.0

​

Features

• API Updates
  • Updated endpoint definitions and API contracts
  • Improved request/response handling
  • Enhanced type definitions and method signatures

​

v1.41.0

​

New Features

• References Support
  • Added References property to material creation and response objects
  • Support for adding source citations with title and URL
  • Enhanced material metadata with reference tracking

​

v1.40.0

​

Features

• Added enableReferenceMode option for chat components and embedding
• Added message grading analytics (prompting and responsibility scores)
• Added update method for materials to update reference information (title and URL)
• API updates with latest endpoint definitions

​

Bug Fixes

• Coerce nullable values to undefined for better TypeScript compatibility
• Updated singularization rules

​

v1.38.0

​

Bug Fixes

• Fixed response structure inconsistencies in API methods
• Corrected property naming conventions across response objects
• Updated method signatures to match actual implementation
• Improved response type definitions for better type safety

​

v1.37.0

​

Documentation Fixes

• Fixed JavaScript code examples across all documentation
• Updated parentFolderId handling in folder operations (use undefined instead of null)
• Added proper null checks for optional fields before accessing properties
• Fixed pagination checks to handle potentially undefined totalPages

​

v1.36.0

​

New Features

• Pagination Support
  • Added pagination parameters (limit and page) to materials.list()
  • Added pagination parameters to folders.listMaterials()
  • Materials list response now returns paginated object with data, limit, page, total, and totalPages

​

Breaking Changes

• Materials List Response
  • Changed from array to paginated object structure
  • Access materials via response.data instead of direct array
  • Added pagination metadata: total, totalPages, page, limit
• Folder Retrieve Response
  • Removed materials field from folder retrieve response
  • Removed totalSize field from folder retrieve response
  • Use folders.listMaterials() or materials.list() with folderId to get folder contents

​

Documentation

• Updated all code examples to use new paginated response structure
• Added examples for iterating through multiple pages
• Added documentation for new folders.listMaterials() method

​

v1.35.0

​

Improvements

• Refactored folders API

​

v1.34.0

​

Breaking Changes

• Assignment Grader API
  • Changed rubricTemplates() to be a property instead of callable
  • Now use rubricTemplates.create(), rubricTemplates.list(), etc.
  • Affects all rubric template operations

​

Documentation

• Updated all code examples to use new rubricTemplates property syntax
• Added migration guide for rubric template changes
• Improved TypeScript type definitions for template operations

​

v1.33.0

​

New Features

• AI-Powered Material Generation
  • Added generate() method to create study materials from topics
  • Added generateAndProcess() method for synchronous generation
  • Support for multiple material types: outlines, overviews, notes, summaries
  • Customizable length, education level, and target folder
• Chat Streaming API
  • Support for both AI SDK format (messages array) and custom format
  • Image attachment support in chat messages
  • Stream processing with proper error handling

​

Improvements

• Enhanced material management with generation capabilities
• Better TypeScript type definitions for generated materials
• Improved streaming performance with chunked responses

​

Documentation

• Added comprehensive material generation guide
• New streaming chat implementation examples
• Updated API reference with all generation parameters

​

v1.27.0

​

New Features

• Guardrails for Chat Component
  • Added enableGuardrails and guardrailRules configuration options
  • Support for BLOCK, WARN, and MODIFY actions on AI responses
  • Server-side content policy enforcement for safety and compliance
• Enhanced Chat Component
  • Added thinking/reasoning capabilities to chat responses
• Keyboard Navigation for Flashcards
  • Arrow keys for card navigation
  • Enhanced accessibility support

​

Improvements

• Component Embed Generation Flexibility
  • Both componentId and _id are now accepted in generateEmbed methods
  • Better backwards compatibility with existing integrations

​

Bug Fixes

• Fixed citation placement in chat responses to correctly scope content within provided materials
• Fixed minor bugs in flashcard component animations and state management
• Fixed test component scoring edge cases

​

v1.26.0

​

New Features

• Added createAndProcess method for materials API
  • Automatically waits for material processing to complete
  • Returns fully processed material ready for immediate use
  • Eliminates need for manual polling of processing status
• Added Data Analyst component API
  • New component type for data analysis and visualization
  • Supports streaming analysis, sessions, and image uploads
  • Includes methods for statistical analysis and chart generation

​

Bug Fixes

• Fixed assignment grader response format
  • Removed inaccessible rubric field from response examples
  • Updated documentation to reflect actual API response structure

​

Documentation

• Added comprehensive rubric creation examples
• Improved material processing documentation
• Added best practices for assignment grading

​

v1.25.0

​

Features

• Initial assignment grader API implementation
• Support for custom rubrics with multiple criteria
• Material-based grading support