Canvas Agent - praxis-ai

Your Digital Twin contains the call_canvas agent specialized in interacting with and retrieving data from Canvas using the Canvas REST APIs.

Overview

The Canvas Agent enables seamless, conversational access to your Canvas Learning Management System through natural language queries. Instead of navigating through multiple web pages and menus, users can simply ask questions and receive immediate, accurate responses powered by Canvas REST APIs.

Benefits and Use Cases

For Students

The Canvas Agent transforms how students interact with their coursework by providing instant access to critical information:

Quick Assignment Lookups: Ask “When is my biology assignment due?” or “What assignments do I have this week?” to get immediate answers
Grade Tracking: Query “What’s my current grade in calculus?” or “Show me my quiz scores” without navigating through multiple pages
Discussion Management: Find out “What discussions do I need to respond to this week?” to stay on top of participation requirements
Deadline Management: Eliminate the stress of clicking through Canvas menus during busy study periods

For Educators

Teachers and instructors gain powerful administrative and pedagogical capabilities:

Student Progress Monitoring: Instantly identify “Which students haven’t submitted their midterm papers?” or “Show me all students who scored below 70% on the last three quizzes”
Data-Driven Instruction: Access participation data, engagement metrics, and performance analytics for early intervention strategies
Administrative Efficiency: Check enrollment numbers, retrieve discussion participation data, and manage course logistics through simple conversations
Content Management: Create discussion posts, manage assignments, and update course materials using natural language commands

Advanced Capabilities

The agent handles sophisticated queries that would typically require multiple manual steps:

Complex filtering and sorting of student data
Bulk operations on assignments and enrollments
Cross-referencing multiple data sources (grades, submissions, participation)
Automated reporting and analytics generation

How It Works

Architecture

Behind the scenes, the Canvas Agent operates through a sophisticated translation layer:

Natural Language Processing: Converts user questions into structured API requests
Authentication Handling: Automatically manages OAuth tokens and session credentials
API Translation: Maps conversational queries to precise Canvas REST API endpoints
Data Formatting: Transforms API responses into human-readable, contextual answers
Error Handling: Gracefully manages API limitations and provides helpful feedback

Example Workflows

Student Query Flow:

User asks: "What discussions do I need to respond to this week?"
↓
Agent queries Canvas discussion topics API
↓
Filters results by due dates and user participation
↓
Returns formatted list of pending discussions

Instructor Query Flow:

User asks: "Create a discussion post about photosynthesis due next Friday"
↓
Agent constructs discussion topic payload
↓
Posts to Canvas discussion API with specified due date
↓
Confirms creation and provides discussion link

Administrative Query Flow:

User asks: "Which students in my AP History class have missing assignments?"
↓
Agent retrieves enrollment data and submission records
↓
Cross-references to identify gaps
↓
Returns actionable list with student details

Role-Based Access Control

The Canvas Agent implements intelligent, automatic role-based access control that adapts to each user’s Canvas permissions:

Automatic Role Detection

The system determines user roles through:

SSO (Single Sign-On) authentication data
OAuth token permissions and scopes
Canvas enrollment and membership information

Permission Levels

Students

Read-Only Access

View assignments and submissions
Check grades and feedback
Access course content
Participate in discussions

Instructors

Teaching Functions

Grade assignments
Manage course content
Create discussions and assignments
View student analytics
Post announcements

Administrators

Full Access

Account management
User enrollment operations
System-wide analytics
Course creation and deletion
Institution-level settings

Security Model

The agent operates conservatively by default, restricting access to only those operations explicitly permitted by the user’s Canvas role. This ensures compliance with institutional policies and prevents unauthorized access to sensitive data.

Key Security Features:

Automatic permission verification before each API call
Scope-based access control aligned with Canvas permissions
Session-based authentication with automatic token refresh
Audit logging of all API interactions
Graceful denial of unauthorized requests with clear messaging

Getting Started

Prerequisites

Before configuring the Canvas Agent, ensure you have:

Administrative access to your Canvas instance
Permissions to create Developer Keys in Canvas
Access to your Praxis Digital Twin configuration panel

Setup Overview

Create Developer Key

Generate API credentials in Canvas to enable communication between Praxis and Canvas

Configure Scopes

Define which API functions your Digital Twin can access

Configure Digital Twin

Add Canvas credentials to your Praxis instance

Test Integration

Verify the connection and authorize access

The Developer Key you create for API access is separate and distinct from any LTI (Learning Tools Interoperability) keys used for embedding Pria as an LTI activity within Canvas.

Multi-Instance Management

For Accounts Managing Multiple Digital Twins: Organizations with multiple Digital Twin instances can streamline configuration by storing Canvas API credentials at the account level:

Centralized Configuration: Set Canvas Client ID and Secret once at the parent account level
Automatic Inheritance: All child Digital Twin instances automatically inherit these credentials
Simplified Maintenance: Update credentials in one place to affect all instances
Focus on Customization: Teachers can concentrate on behavior and content personalization rather than technical setup

Contact our support team to configure account-level Canvas credentials. This is recommended once your API scopes and configuration attributes have stabilized in your development environment.

Create Developer Keys

Developer Keys provide the authentication credentials necessary for your Digital Twin to communicate with Canvas through REST APIs.

Only one Developer Key is needed per institution and can be shared across multiple Praxis instances.

Step-by-Step Configuration

Navigate to Admin Panel

Click Admin in the left navigation menu, then select your institution’s account (e.g., “Praxis AI”).

Access Developer Keys

In the account settings, select Developer Keys from the navigation menu.

Create New API Key

a. Click the + Developer Key button in the top-right corner

b. Select + API Key from the dropdown menu

Configure Key Settings

Fill in the following required fields:

Field	Value	Purpose
Key Name	`Pria Smart Search`	Displayed in OAuth consent form
Owner Email	Your institution’s admin email	Contact for key management
Redirect URI	`https://pria.praxislxp.com/api/auth/token_complete`	OAuth callback endpoint
Icon URL	`https://pria.praxislxp.com/logo192.png`	Displayed in consent form

Leave all other fields empty.

Review OAuth Consent

This is the authorization screen students and instructors will see when first connecting to Canvas:

Configure API Scopes

a. Check the Enforce Scopes checkbox located to the right of the Key Name field

b. Use the search box to find specific API functions (e.g., type “smart” to locate Smart Search)c. Check the boxes for each API function you want to authorize

Repeat this process to authorize additional API functions as needed. See the Canvas Scopes section for detailed scope information.

Development Mode: While developing and testing, you may choose to disable scope enforcement to allow unrestricted API access. During this phase, monitor the Agent Details in your dialog history to identify which endpoints your queries use. Document these for production scope configuration.

d. Click Save in the bottom-right cornere. Enable the Developer Key by toggling the State button to “ON”

Copy Credentials

Under the Details section:

Copy the Client ID (the numeric identifier, e.g., XXX217)
Click Show Key and copy the Client Secret

Store these credentials securely—you’ll need them for Digital Twin configuration.

Remember: One Developer Key can serve multiple Praxis instances. You’ll use these credentials when configuring each Digital Twin that needs Canvas access.

Understanding Scope Enforcement

When you enable scopes for Pria’s API integration, you establish precise security boundaries:

Explicit Permissions: Define exactly which Canvas operations Pria can perform on behalf of users
Principle of Least Privilege: Grant only the minimum access necessary for required functionality
Data Protection: Ensure Pria accesses only the data it needs to function
Audit Trail: Track which API functions are authorized and used

Pria’s Canvas Agent automatically implements role-based access control that respects Canvas’s native permission system. Even with broad API scopes enabled, individual users can only perform actions appropriate to their Canvas role (student, instructor, administrator).

Digital Twin Configuration

After creating your Developer Key in Canvas, you need to configure your Digital Twin instance with the API credentials.

Configuration Steps

Access Admin Panel

Click the Admin (⌂) icon at the top of your Praxis interface.

Locate Your Instance

Find your Digital Twin instance in the list and click the green Edit pencil icon on the left.

Add API Credentials

In the Edit Instance panel:a. Scroll down to the Integration sectionb. Locate the Canvas Client ID and Canvas Client Secret fieldsc. Paste the credentials you copied from the Canvas Developer Key

Save Configuration

Click Update at the bottom of the panel to save your changes.

These credentials enable your Digital Twin to authenticate with Canvas on behalf of users. The actual user permissions are determined by their Canvas role and the OAuth authorization they grant.

Testing Your Canvas Integration

Once configuration is complete, verify that your Digital Twin can successfully connect to Canvas.

Initial Connection Test

Ask a Canvas Question

Navigate to your Digital Twin and ask a Canvas-related question:

What is my course syllabus in Canvas?

Show me my upcoming assignments

Authorize Access

On first connection (or when your token expires), you’ll be prompted to authorize your Digital Twin to access Canvas:

Click the authorization link provided
Review the permissions requested
Click Authorize in the Canvas OAuth consent screen
You’ll be redirected back to Praxis automatically

Verify Response

Your Digital Twin should return relevant information from your Canvas course, confirming successful integration.

Agent Details

A comprehensive audit log of the Digital Twin’s Canvas interactions via the call_canvas agent is available in the Agent Details section of each response, allowing you to review successful execution status and identify the specific API functions that were called during the interaction.

Token Management: Access tokens are valid for 60 minutes and are automatically refreshed in the background to maintain seamless access. You typically only need to authorize once per session or when tokens expire.

What to Test

Verify different types of queries based on your role: Students:

What assignments are due this week?
Show me my current grades
What discussions do I need to respond to?

Instructors:

Which students haven't submitted the midterm?
Show me average scores for the last quiz
Create a discussion post about [topic] due next Friday

Administrators:

How many students are enrolled in Biology 101?
Show me course completion rates
List all active courses in the department

Troubleshooting

Standalone accounts

Instance not properly configured: Your account is stand alone and is not integrated with Canvas. It must be associated to an instance properly configured by your Teacher or Administrator.

Invalid or missing API URL

Symptom: Authentication fails or redirects to the wrong Canvas instance Instance not properly configured: Access to Canvas LMS requires a valid Authorized Public URL property for your instance! This value can be configured using the Administration UI. For missing or incorrect API Url Cause: The system cannot determine your institution’s Canvas domain, or there’s a mismatch in the authorized URLs configuration. Solution:

Check Authorized URLs

In your Digital Twin configuration, ensure the first line of your Public Authorized URLs contains your institution’s primary Canvas domain:

https://your-institution.instructure.com

Verify Domain Priority

The Canvas Agent uses the first domain in your authorized URLs list that matches your institution. Order matters:Correct Order:

https://school.instructure.com
https://school.beta.instructure.com

The agent will use school.instructure.com (production)

Production vs. Test Instances: It is strongly recommended NOT to share a single Digital Twin between production and test Canvas instances. This can cause domain confusion and authentication failures.If you must use both environments, the Canvas Agent will select the first domain in your authorized URLs list that contains either:

Your institution’s domain (e.g., school.edu)
instructure.com (Canvas cloud hosting)

Invalid or missing Client ID or Secret

Symptom: Error message about Client ID or Secret missing Instance not properly configured: Access to Canvas LMS requires a valid Client Id for your instance! This value can be configured using the Administration UI. Instance not properly configured: Access to Canvas LMS requires a valid client secret for your instance! This value can be configured using the Administration UI. Solution:

Verify that you’ve copied the correct Client ID and Secret from Canvas
Ensure the Developer Key is enabled in Canvas
Check that the Redirect URI in Canvas matches: https://pria.praxislxp.com/api/auth/token_complete
Update your Digital Twin instance with the correct credentials

Invalid or missing Course information

Integration user issue: Access to Canvas LMS requires a valid course Id. Please launch from a valid course page in your Canvas instance!

Insufficient Scopes Error

Error Message:

{
  "errors": [{
    "message": "Insufficient scopes on access token."
  }],
  "error_report_id": "1288266"
}

Example:

Access to Canvas LMS API function at https://institution.instructure.com/api/v1/courses/53493/assignments 
is Unauthorized (401). Insufficient scopes on access token.

Cause: The API endpoint being accessed requires a scope that hasn’t been authorized in your Canvas Developer Key. Solution:

Identify Required Scope

From the error message, note the endpoint path (e.g., /api/v1/courses/:course_id/assignments)

Add Scope in Canvas

Return to Canvas Developer Keys
Edit your Pria API key
Search for and enable the required scope
Save changes

Generate New Token

Users will need to re-authorize to receive a token with the updated scopes:

Log out of Praxis
Log back in
Re-authorize Canvas access when prompted

Important: When scopes are enforced, they must be defined in both locations:

Your Canvas Developer Key (authorizes the scopes)
Your Digital Twin configuration (declares required scopes)

Any modifications to the scope list require generating new access tokens, as scopes are embedded in the token at creation time.

Token Expiration Issues

Symptom: Frequent re-authorization requests or “token expired” messages Cause: Access tokens expire after 60 minutes of inactivity Solution: This is normal behavior. The system automatically refreshes tokens in the background. If you’re prompted to re-authorize:

Click the authorization link
Approve the request in Canvas
Continue your session

If you experience excessive re-authorization requests, check that your browser allows cookies from pria.praxislxp.com and your Canvas domain.

Removing Token

When scopes have changed and require a new token, or to simply re-issue a new authorization token:

Go to Profile

Click the Profile link in the top navigation menu.

Remove Token

Click the Remove Token button to remove your OAuth token for Canvas.

Issue New Token

To generate a new token, simply ask a question about content on Canvas and follow the OAuth2 authorization flow.

Canvas Scopes

Understanding Scopes

Canvas API scopes are granular permission controls that define exactly which actions an application can perform when accessing Canvas data through the REST API. Key Concepts:

Principle of Least Privilege: Applications should only have access to what they absolutely need
Endpoint-Specific: Each scope corresponds to specific API endpoints and HTTP methods
Security Layer: Scopes work in conjunction with user roles to enforce access control

Applications should only have access to what they absolutely need. Over-permissioning creates security risks and violates best practices.

Scope Anatomy

Each scope is a pipe-delimited string with three components:

url:<HTTP_METHOD>|<API_ENDPOINT>

Components:

Literal prefix: Always starts with url:
HTTP Method: GET, POST, PUT, or DELETE
Endpoint Path: The API path without the domain

Example Scope:

url:GET|/api/v1/courses/:course_id/enrollments

This scope allows:

Method: GET (read-only)
Resource: Course enrollments
Context: Within a specific course

Path Variables: URL parameters are written with colon notation (e.g., :user_id, :course_id, :assignment_id). When defining scopes, ensure variable names match exactly—scope comparison is token-based and case-sensitive.

Official Documentation

For the complete, authoritative list of all available Canvas API scopes and endpoints, consult: Canvas REST API Documentation

Common Scopes by Category

Assignments

List Assignments:

Endpoint: /api/v1/courses/:course_id/assignments
Scope: url:GET|/api/v1/courses/:course_id/assignments

Get Single Assignment:

Endpoint: /api/v1/courses/:course_id/assignments/:id
Scope: url:GET|/api/v1/courses/:course_id/assignments/:id

Update Submission (grading, comments):

Endpoint: /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
Scope: url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

List Submissions:

Endpoint: /api/v1/courses/:course_id/assignments/:assignment_id/submissions
Scope: url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions

Discussions

List Discussion Topics:

Endpoint: /api/v1/courses/:course_id/discussion_topics
Scope: url:GET|/api/v1/courses/:course_id/discussion_topics

Create Discussion:

Endpoint: /api/v1/courses/:course_id/discussion_topics
Scope: url:POST|/api/v1/courses/:course_id/discussion_topics

Get Discussion Entries:

Endpoint: /api/v1/courses/:course_id/discussion_topics/:topic_id/entries
Scope: url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries

Grades & Submissions

List All Submissions:

Endpoint: /api/v1/courses/:course_id/submissions
Scope: url:GET|/api/v1/courses/:course_id/submissions

Get User Grades:

Endpoint: /api/v1/courses/:course_id/students/submissions
Scope: url:GET|/api/v1/courses/:course_id/students/submissions

Quizzes

List Quizzes:

Endpoint: /api/v1/courses/:course_id/quizzes
Scope: url:GET|/api/v1/courses/:course_id/quizzes

Get Quiz Submissions:

Endpoint: /api/v1/courses/:course_id/quizzes/:quiz_id/submissions
Scope: url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions

Announcements

List Announcements:

Endpoint: /api/v1/courses/:course_id/announcements
Scope: url:GET|/api/v1/courses/:course_id/announcements

Create Announcement:

Endpoint: /api/v1/courses/:course_id/discussion_topics
Scope: url:POST|/api/v1/courses/:course_id/discussion_topics

(Announcements are special discussion topics)

Modules & Content

List Modules:

Endpoint: /api/v1/courses/:course_id/modules
Scope: url:GET|/api/v1/courses/:course_id/modules

List Module Items:

Endpoint: /api/v1/courses/:course_id/modules/:module_id/items
Scope: url:GET|/api/v1/courses/:course_id/modules/:module_id/items

List Pages:

Endpoint: /api/v1/courses/:course_id/pages
Scope: url:GET|/api/v1/courses/:course_id/pages

Get Page Content:

Endpoint: /api/v1/courses/:course_id/pages/:url_or_id
Scope: url:GET|/api/v1/courses/:course_id/pages/:url_or_id

Users & Enrollments

List Course Users:

Endpoint: /api/v1/courses/:course_id/users
Scope: url:GET|/api/v1/courses/:course_id/users

List Enrollments:

Endpoint: /api/v1/courses/:course_id/enrollments
Scope: url:GET|/api/v1/courses/:course_id/enrollments

Files & Documents

List Course Files:

Endpoint: /api/v1/courses/:course_id/files
Scope: url:GET|/api/v1/courses/:course_id/files

Get File Details:

Endpoint: /api/v1/courses/:course_id/files/:id
Scope: url:GET|/api/v1/courses/:course_id/files/:id

Groups

List Course Groups:

Endpoint: /api/v1/courses/:course_id/groups
Scope: url:GET|/api/v1/courses/:course_id/groups

Rubrics

List Rubrics:

Endpoint: /api/v1/courses/:course_id/rubrics
Scope: url:GET|/api/v1/courses/:course_id/rubrics

Assignment Groups

List Assignment Groups:

Endpoint: /api/v1/courses/:course_id/assignment_groups
Scope: url:GET|/api/v1/courses/:course_id/assignment_groups

Analytics

Course Activity:

Endpoint: /api/v1/courses/:course_id/analytics/activity
Scope: url:GET|/api/v1/courses/:course_id/analytics/activity

Assignment Analytics:

Endpoint: /api/v1/courses/:course_id/analytics/assignments
Scope: url:GET|/api/v1/courses/:course_id/analytics/assignments

Student Summaries:

Endpoint: /api/v1/courses/:course_id/analytics/student_summaries
Scope: url:GET|/api/v1/courses/:course_id/analytics/student_summaries

Individual Student Activity:

Endpoint: /api/v1/courses/:course_id/analytics/users/:student_id/activity
Scope: url:GET|/api/v1/courses/:course_id/analytics/users/:student_id/activity

Smart Search

Smart Search (recommended fallback):

Endpoint: /api/v1/courses/:course_id/smartsearch
Scope: url:GET|/api/v1/courses/:course_id/smartsearch

Calendar

User Calendar Events:

Endpoint: /api/v1/users/:user_id/calendar_events
Scope: url:GET|/api/v1/users/:user_id/calendar_events

Choosing Scopes for Your Use Case

Select scopes based on the specific functionality your Digital Twin needs to provide: Example: Auto-Grader Assistant

url:GET|/api/v1/courses/:course_id/assignments
url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

Example: Student Support Bot

url:GET|/api/v1/courses/:course_id/assignments
url:GET|/api/v1/courses/:course_id/discussion_topics
url:GET|/api/v1/courses/:course_id/pages
url:GET|/api/v1/users/:user_id/calendar_events

Example: Course Analytics Dashboard

url:GET|/api/v1/courses/:course_id/analytics/activity
url:GET|/api/v1/courses/:course_id/analytics/assignments
url:GET|/api/v1/courses/:course_id/analytics/student_summaries
url:GET|/api/v1/courses/:course_id/submissions

Best Practices for Scope Management

Recommended Development Workflow:

Development Phase: Disable scope enforcement to allow unrestricted API exploration
Documentation Phase: Monitor Agent Details in dialog history to identify all endpoints used
Compilation Phase: Create a comprehensive list of required scopes in a JSON file
Testing Phase: Enable scope enforcement and test all functionality
Production Phase: Deploy with minimal, verified scopes

This approach ensures you grant exactly the permissions needed—no more, no less.

Starter Scope Configuration

Use this starter JSON as a foundation for your scope configuration. This includes commonly used endpoints for typical Digital Twin functionality:

[
  "url:GET|/api/v1/courses/:course_id/analytics/activity",
  "url:GET|/api/v1/courses/:course_id/analytics/assignments",
  "url:GET|/api/v1/courses/:course_id/analytics/student_summaries",
  "url:GET|/api/v1/courses/:course_id/analytics/users/:student_id/activity",
  "url:GET|/api/v1/courses/:course_id/announcements",
  "url:GET|/api/v1/courses/:course_id/assignments",
  "url:GET|/api/v1/courses/:course_id/assignments/:id",
  "url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions",
  "url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id",
  "url:GET|/api/v1/courses/:course_id/assignment_groups",
  "url:GET|/api/v1/courses/:course_id/discussion_topics",
  "url:GET|/api/v1/courses/:course_id/enrollments",
  "url:GET|/api/v1/courses/:course_id/files",
  "url:GET|/api/v1/courses/:course_id/files/:id",
  "url:GET|/api/v1/courses/:course_id/groups",
  "url:GET|/api/v1/courses/:course_id/modules",
  "url:GET|/api/v1/courses/:course_id/modules/:module_id/items",
  "url:GET|/api/v1/courses/:course_id/pages",
  "url:GET|/api/v1/courses/:course_id/pages/:url_or_id",
  "url:GET|/api/v1/courses/:course_id/quizzes",
  "url:GET|/api/v1/courses/:course_id/smartsearch",
  "url:GET|/api/v1/courses/:course_id/submissions",
  "url:GET|/api/v1/courses/:course_id/users",
  "url:GET|/api/v1/users/:user_id/calendar_events"
]

Latest Version: The most current version of this starter configuration is maintained in the Praxis AI Community Repository - please contribute:Canvas Scopes Configuration

Scope Troubleshooting

Insufficient Scopes Error:

Access to Canvas LMS API function at https://institution.instructure.com/api/v1/courses/53493/assignments 
is Unauthorized (401). 
{"errors":[{"message":"Insufficient scopes on access token."}],"error_report_id":"1288266"}

Resolution Steps:

Identify the missing scope from the error message endpoint
Add the scope to your Canvas Developer Key
Ensure the scope is also listed in your Digital Twin configuration
Have users re-authorize to receive updated tokens

Critical Scope Requirement: When scopes are enforced, they must be defined in both locations:

Canvas Developer Key (authorizes the application to use these scopes)
Digital Twin Configuration (declares which scopes to request during OAuth)

Modifying scopes requires generating new access tokens, as scope permissions are embedded in the token at creation time and cannot be changed retroactively.

Smart Search

Canvas Smart Search provides an intelligent fallback mechanism when specific API endpoints are unavailable or return insufficient data due to scope restrictions.

What is Smart Search?

Smart Search is Canvas’s AI-powered search capability that allows natural language queries across course content, returning relevant results from:

Assignments and submissions
Discussion topics and posts
Pages and modules
Files and documents
Announcements
Quiz content

How the Canvas Agent Uses Smart Search

The Canvas Agent automatically falls back to Smart Search when:

Specific API endpoints lack required scopes
Direct API queries return no results
Complex cross-resource queries are needed
Natural language search provides better context

API Endpoint:

GET /api/v1/courses/:course_id/smartsearch

Required Scope:

url:GET|/api/v1/courses/:course_id/smartsearch

Official Documentation

For detailed information about Smart Search capabilities and parameters: Canvas Smart Search API Documentation

Availability and Requirements

Environment Availability: According to Canvas deployment notes, Smart Search is available only for Beta and Production releases. It may not be available in test or development Canvas instances.If you experience issues with Smart Search even after proper configuration, contact Instructure Support to verify that your Canvas instance has Smart Search enabled.

Best Practices

Recommended Configuration: Always include the Smart Search scope in your production configuration:

"url:GET|/api/v1/courses/:course_id/smartsearch"

This ensures your Digital Twin can gracefully handle edge cases and provide comprehensive search capabilities even when specific API scopes are restricted.

Additional Resources

Documentation Links

Support

For assistance with Canvas Agent configuration or troubleshooting:

Search for help on the Canvas Community
Contact Praxis AI Support for Digital Twin configuration issues
Contact Instructure Support for Canvas-specific API or Smart Search availability questions

Community Examples

Explore real-world implementations and advanced use cases in the Praxis AI Community Repository:

Integrations

Instructure Canvas

Web App

MCP Server

D2L Brightspace

SDK

​Overview

​Benefits and Use Cases

​For Students

​For Educators

​Advanced Capabilities

​How It Works

​Architecture

​Example Workflows

​Role-Based Access Control

​Automatic Role Detection

​Permission Levels

Students

Instructors

Administrators

​Security Model

​Getting Started

​Prerequisites

​Setup Overview

​Multi-Instance Management

​Create Developer Keys

​Step-by-Step Configuration

​Understanding Scope Enforcement

​Digital Twin Configuration

​Configuration Steps

​Testing Your Canvas Integration

​Initial Connection Test

​What to Test

​Troubleshooting

​Standalone accounts

​Invalid or missing API URL

​Invalid or missing Client ID or Secret

​Invalid or missing Course information

​Insufficient Scopes Error

​Token Expiration Issues

​Removing Token

​Canvas Scopes

​Understanding Scopes

​Scope Anatomy

​Official Documentation

​Common Scopes by Category

​Choosing Scopes for Your Use Case

​Best Practices for Scope Management

​Starter Scope Configuration

​Scope Troubleshooting

​Smart Search

​What is Smart Search?

​How the Canvas Agent Uses Smart Search

​Official Documentation

​Availability and Requirements

​Best Practices

​Additional Resources

​Documentation Links

​Support

​Community Examples

Overview

Benefits and Use Cases

For Students

For Educators

Advanced Capabilities

How It Works

Architecture

Example Workflows

Role-Based Access Control

Automatic Role Detection

Permission Levels

Security Model

Getting Started

Prerequisites

Setup Overview

Multi-Instance Management

Create Developer Keys

Step-by-Step Configuration

Understanding Scope Enforcement

Digital Twin Configuration

Configuration Steps

Testing Your Canvas Integration

Initial Connection Test

What to Test

Troubleshooting

Standalone accounts

Invalid or missing API URL

Invalid or missing Client ID or Secret

Invalid or missing Course information

Insufficient Scopes Error

Token Expiration Issues

Removing Token

Canvas Scopes

Understanding Scopes

Scope Anatomy

Official Documentation

Common Scopes by Category

Choosing Scopes for Your Use Case

Best Practices for Scope Management

Starter Scope Configuration

Scope Troubleshooting

Smart Search

What is Smart Search?

How the Canvas Agent Uses Smart Search

Official Documentation

Availability and Requirements

Best Practices

Additional Resources

Documentation Links

Support

Community Examples