Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Study Assist API

2 actions 2 updates phrasing extends openapi/canvas-study-assist-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/courses/{course_id}/study_assist'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canvas LMS REST Study Assist API
  version: 1.0.0
extends: openapi/canvas-study-assist-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/courses/{course_id}/study_assist'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask the course study assistant a question
      effect: write
      questions:
      - Can I ask an AI study helper a question about my course material?
      - Is it possible to regenerate a study assist answer I didn't like?
      instructions:
      - text: 'Ask the study assistant in course {course_id}: {prompt}.'
        slots:
          course_id: path.course_id
          prompt: requestBody.prompt
      - text: Regenerate the study assist response in course {course_id} with regenerate set to {regenerate}.
        slots:
          course_id: path.course_id
          regenerate: requestBody.regenerate
      method: generated
      generated: '2026-10-01'