Skip to main content

Course Formats

Thought Industries supports multiple content formats (called kind in the API). Understanding these formats is crucial for creating the right type of learning experience.

Available Formats​

courseGroup​

A structured course with sections, lessons, and topics.

Use Cases:

  • Multi-lesson training programs
  • Comprehensive learning paths
  • Certification programs
  • Structured curricula

API Value: "kind": "courseGroup"

Required Structure:

{
  "kind": "courseGroup",
  "sections": [
    {
      "title": "Section 1",
      "lessons": [
        {
          "title": "Lesson 1",
          "openType": "studentsOnly",
          "topics": [
            {
              "title": "Topic 1",
              "type": "text",
              "body": "<p>Content</p>"
            }
          ]
        }
      ]
    }
  ]
}

article​

Article or blog-style content with rich text and multilingual support.

Use Cases:

  • Knowledge base articles
  • How-to guides
  • Product documentation
  • Blog posts

API Value: "kind": "article"

Required Structure:

{
  "kind": "article",
  "articleVariant": {
    "language": "en",
    "label": "English",
    "title": "Article Title",
    "body": "<p>Article content</p>"
  }
}

microCourse​

Bite-sized learning experiences with multiple topics.

Use Cases:

  • Microlearning modules
  • Quick tips
  • Mobile-first learning
  • Daily lessons

API Value: "kind": "microCourse"

Required Structure:

{
  "kind": "microCourse",
  "topics": [
    {
      "title": "Topic 1",
      "type": "text",
      "body": "<p>Content</p>"
    }
  ]
}

video​

Video-based learning content.

Use Cases:

  • Video tutorials
  • Webinar recordings
  • Demonstrations
  • Lectures

API Value: "kind": "video"

Structure: Similar to courseGroup but optimized for video delivery. Topics use video assets.

shareableContentObject​

SCORM packages (SCORM 1.2 and SCORM 2004).

Use Cases:

  • Legacy e-learning content
  • Interactive simulations
  • Assessment-heavy content
  • Third-party SCORM courses

API Value: "kind": "shareableContentObject"

Required Fields:

{
  "kind": "shareableContentObject",
  "scormUrl": "https://cdn.example.com/package.zip",
  "width": 800,
  "height": 600
}

xApiObject​

xAPI (Tin Can) compliant content.

Use Cases:

  • Modern e-learning packages
  • Experience tracking
  • Advanced analytics
  • Mobile learning content

API Value: "kind": "xApiObject"

Required Fields:

{
  "kind": "xApiObject",
  "scormUrl": "https://cdn.example.com/xapi-package.zip",
  "width": 800,
  "height": 600
}

Format Selection Guide​

FormatStructure ComplexityBest ForMobile-Friendly
courseGroupHighComprehensive courses✓
articleLowDocumentation, blogs✓✓✓
microCourseMediumQuick learning✓✓✓
videoMediumVideo content✓✓
shareableContentObjectLowSCORM content✓
xApiObjectLowxAPI content✓

Choosing the Right Format​

Choose courseGroup when:​

  • You need structured learning with multiple sections
  • Content requires sequential progression
  • Building a comprehensive training program
  • Need complex hierarchy of content

Choose article when:​

  • Content is primarily text-based
  • Need multilingual support
  • Creating knowledge base articles
  • Want SEO-optimized content

Choose microCourse when:​

  • Content is bite-sized (5-15 minutes)
  • Targeting mobile learners
  • Creating daily tips or lessons
  • Want flexible topic ordering

Choose video when:​

  • Primary content is video
  • Creating video courses or tutorials
  • Recording lectures or demonstrations

Choose shareableContentObject when:​

  • You have existing SCORM packages
  • Need SCORM compliance
  • Using third-party e-learning tools
  • Require standard tracking

Choose xApiObject when:​

  • Using modern xAPI content
  • Need advanced experience tracking
  • Want detailed analytics
  • Building mobile-first content

Format-Specific Considerations​

courseGroup​

  • Pros: Most flexible, full feature set, great for complex content
  • Cons: Requires complete structure definition
  • Required: sections → lessons → topics hierarchy

article​

  • Pros: Simple to create, SEO-friendly, multilingual support
  • Cons: Limited interactivity
  • Required: articleVariant object

microCourse​

  • Pros: Mobile-optimized, quick to create, flexible
  • Cons: Limited structure
  • Required: topics array

SCORM/xAPI​

  • Pros: Standards-compliant, works with existing content
  • Cons: Requires package preparation
  • Required: scormUrl, width, height

Next Steps​

Explore format-specific examples: