canvas.courses.upload-file

Upload a file to the course. This API endpoint is the first step in uploading a file to a course. See the {file:file.file_uploads.html File Upload Documentation} for details on the file upload workflow. Only those with the "Manage Files" permission on a course can upload files to the course. By default, this is Teachers, TAs and Designers.

Upload a file

Overview

Property	Value
Workflow type	Atomic
Library	App-canvas
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Canvas API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
course_id	string	Yes	—	ID

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Canvas API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
course_id	string	Yes	—	ID
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /v1/courses/{course_id}/files
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /v1/courses/{course_id}/files
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "canvas.courses.upload-file",
  "initial_data": {
    "base_url": "value",
    "course_id": "value"
  }
}