AI Conversations

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

AI Conversations API

API for managing conversations with AI Experiences.

Get active conversation

AiConversationsController#active_conversation

GET /api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations

Scope: url:GET|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations

Get the active conversation for the current user and AI experience

Create AI conversation

AiConversationsController#create

POST /api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations

Scope: url:POST|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations

Initialize a new conversation with the AI experience

Post message to conversation

AiConversationsController#post_message

POST /api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/messages

Scope: url:POST|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/messages

Send a message to an existing conversation and get the AI response

Request Parameters:

Parameter	Type	Description
message	Required string	The user’s message to send to the AI

Delete AI conversation

AiConversationsController#destroy

DELETE /api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id

Scope: url:DELETE|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id

Mark a conversation as completed/deleted

---

This documentation is generated directly from the Canvas LMS source code, available on Github.