Note: all PUTs accept partial parameter lists, and will only update the given parameters.

Resources

Api Oauth Applications

Resource Description
POST /api/public/oauth/applications Creates an oauth2 application
GET /api/public/oauth/applications List all oauth2 applications
GET /api/public/oauth/applications/:id Show oauth2 application
DELETE /api/public/oauth/applications/:id Destroy oauth2 application

Api Oauth Approved Integrations

Resource Description
GET /api/public/oauth/approved_integrations List all oauth2 tokens for current user
PUT /api/public/oauth/approved_integrations/:id/revoke Revoke the token with the specified id

Auth Sessions

Resource Description
POST /api/auth/session Creates a new user session
GET /api/auth/session Returns the current status of the session
DELETE /api/auth/session Destroys the active user session, effectively logging the user out

Lti Keys

Resource Description
GET /api/lti/keys Returns a list of all LTI keys
GET /api/lti/keys/:id Returns a specific LTI key
POST /api/lti/keys Creates a new LTI key for an account
DELETE /api/lti/keys/:id Destroys a specific LTI key

Lti Launch Params

Resource Description
GET /api/lti/launch_params Returns the decoded LTI parameters.

Lti User Ties

Resource Description
POST /api/lti/user_ties Ties a user to the given LTI parameters

Lti Users

Resource Description
POST /api/lti/users Creates a new user from an LTI launch

Partner Auth Canvas

Resource Description
GET /partner_auth/canvas/login Initiates an OAuth2 login from Canvas
GET /partner_auth/canvas/handle_response Canvas OAuth2 redirect target
GET /partner_auth/canvas/complete Finishes an OAuth2 login from Canvas

Tweed Media Management Annotation Sets

Resource Description
GET /api/media_management/media/:media_id/annotation_sets List annotation sets for given media
POST /api/media_management/media/:media_id/annotation_sets Create a new annotation set for given media
DELETE /api/media_management/annotation_sets/:id Destroys an annotation set

Tweed Media Management Annotations

Resource Description
POST /api/media_management/annotation_sets/:annotation_set_id/annotations Create a new annotation for given annotation set
DELETE /api/media_management/annotations/:id Destroys an annotation

Tweed Media Management Caption Files

Resource Description
GET /api/media_management/media/:media_id/caption_files Lists caption files associated with given media object
POST /api/media_management/media/:media_id/caption_files Creates a new caption file for a given media object
POST /api/media_management/perspectives/:id/auto_caption Enqueues a request to generate an ASR caption file for a given Perspective
GET /api/media_management/caption_files/:id Renders the requested caption file for the given media object
PATCH /api/media_management/caption_files/:id Updates sequences in caption file
PUT /api/media_management/caption_files/:id Updates sequences in caption file
PUT /api/media_management/caption_files/:id/publish Publishes the caption file with the given id
DELETE /api/media_management/caption_files/:id Deletes the caption file with the given id

Tweed Media Management Collections

Resource Description
GET /api/media_management/collections Lists all collections for a user
POST /api/media_management/collections Create a custom collection for a user
GET /api/media_management/collections/:id Views a collection
PATCH /api/media_management/collections/:id Update a custom collection
PUT /api/media_management/collections/:id Update a custom collection
DELETE /api/media_management/collections/:id Destroy a collection

Tweed Media Management Comment Subscriptions

Resource Description
POST /api/media_management/perspectives/:perspective_id/comment_subscriptions Creates a new comment subscription for a given perspective or comment
DELETE /api/media_management/comment_subscriptions/:id Deletes the specified comment subscription
GET /api/media_management/perspectives/:perspective_id/comment_subscriptions List all comment subscriptions associated with a given perspective

Tweed Media Management Comments

Resource Description
GET /api/media_management/perspectives/:perspective_id/comments List all comments associated with a given perspective
POST /api/media_management/perspectives/:perspective_id/comments Creates a new comment for a given perspective
PATCH /api/media_management/comments/:id Update the specified comment
PUT /api/media_management/comments/:id Update the specified comment
DELETE /api/media_management/comments/:id Deletes the specified comment
GET /api/media_management/comments/:comment_id/replies Lists replies for the specified comment
POST /api/media_management/comments/:comment_id/reply Creates a comment reply

Tweed Media Management Embeddings

Resource Description
POST /api/media_management/embeddings Create a new Embedding
GET /api/media_management/embeddings/:id/lti_perspective Fetches the Perspective ID corresponding to the provided LTI launch params and Embedding UUID.

Tweed Media Management Lambda

Resource Description
POST /api/media_management/lambda/process_events Process notorious events from lambda

Tweed Media Management Media

Resource Description
POST /api/media_management/media Creates a new Media object in your "My Uploads" and returns the corresponding Perspective.
GET /api/media_management/embed/:embed_id Returns an anonymously accessible media object, typically used for embedding the video externally
GET /api/media_management/lti_media Returns a media object for LTI non-perspective launches
GET /api/media_management/media/:id Returns the media object with the given id.
GET /api/media_management/media/:media_id/lti_perspective Fetches the perspective id corresponding to the provided LTI launch params and media launch id.
PATCH /api/media_management/media/:id Updates the media object with the given id
PUT /api/media_management/media/:id Updates the media object with the given id
DELETE /api/media_management/media/:id Deletes the specified media object
GET /api/media_management/media/:media_id/pandata_tokens Returns the pandata tokens of the media with the given id.
GET /api/media_management/media/:media_id/perspectives For the given media, returns the perspectives to which the user has at least view access.
GET /api/media_management/media/:media_id/presigned_url Return presigned GET url for uploaded media original

Tweed Media Management Participant Sessions

Resource Description
GET /api/media_management/perspectives/:perspective_id/participant_sessions Get sessions for the current user for the given perspective
POST /api/media_management/perspectives/:perspective_id/participant_sessions Create a session for the current user for the given perspective
POST /api/media_management/participant_sessions/:participant_session_id/take_token Return a token for the quiz api scoped to taking a quiz
POST /api/media_management/participant_sessions/:participant_session_id/results_token Return a token for the quiz api scoped to viewing quiz results
POST /api/media_management/participant_sessions/:participant_session_id/grade_token Return a token for the quiz api scoped to viewing quiz results
POST /api/media_management/participant_sessions/:participant_session_id/complete Complete a quiz and submit the score

Tweed Media Management Perspective Permissions

Resource Description
GET /api/media_management/perspectives/:perspective_id/perspective_permissions Lists Permissions for a Perspective
POST /api/media_management/perspectives/:perspective_id/perspective_permissions Sets permissions for users on a perspective
DELETE /api/media_management/perspective_permissions/:id Deletes the specified Perspective Permission
POST /api/media_management/perspectives/:perspective_id/perspective_permissions/batch_update Batch create/update/destroy permissions in a single transaction. i.e. if one operation fails, they all do.

Tweed Media Management Perspectives

Resource Description
GET /api/media_management/collections/:collection_id/perspectives Lists all the media perspectives in the given collection
POST /api/media_management/collections/:collection_id/perspectives Creates a perspective in a collection with media
GET /api/media_management/perspectives/:id Returns the perspective with the given id.
POST /api/media_management/perspectives/:id/restart_quiz_clone Restarts the quiz clone job for a perspective whose clone job has failed
GET /api/media_management/perspectives/:perspective_id/pandata_tokens Returns the pandata tokens of the perspective with the given id.
POST /api/media_management/perspectives/:id/create_embed Adds the Perspective's Media to a Course Collection for the given course_id. Returns the URL to LTI-launch the embedded media.
GET /api/media_management/perspectives/search Searches for perspectives matching the given query.
PATCH /api/media_management/perspectives/:id Updates the perspective with the given id.
PUT /api/media_management/perspectives/:id Updates the perspective with the given id.
DELETE /api/media_management/perspectives/:id Deletes the specified perspective on the media.
GET /api/media_management/perspectives/:perspective_id/roster Lists users that are allowed to view perspective.
GET /api/media_management/perspectives/:perspective_id/insights Returns the insights for a given perspective id
POST /api/media_management/perspectives/:perspective_id/quiz_analysis_token Returns a token scoped to analysis of quiz results
POST /api/media_management/perspectives/:perspective_id/quiz_moderation_token Returns a token scoped to moderation of quizzes

Tweed Media Management Public Embeds

Resource Description
POST /api/media_management/media/:media_id/public_embed Generates an embed id for the specified media
DELETE /api/media_management/media/:media_id/public_embed Deletes the embed id for the specified media

Tweed Media Management Question Frames

Resource Description
DELETE /api/media_management/question_frames/:id Destroy a question frame
POST /api/media_management/quiz_templates/:quiz_template_id/quiz_template_revisions/latest/question_frames Create a new question frame

Tweed Media Management Quiz Participants

Resource Description
GET /api/media_management/perspectives/:perspective_id/quiz_participants Get sessions for the current user for the given perspective

Tweed Media Management Quiz Template Revisions

Resource Description
POST /api/media_management/quiz_templates/:quiz_template_id/quiz_template_revisions/latest Return the latest revision for the specified quiz template, creating a new one if necessary
POST /api/media_management/quiz_template_revisions/:quiz_template_revision_id/build_token Return a token for the quiz api scoped to building a quiz

Tweed Media Management Quiz Templates

Resource Description
POST /api/media_management/media/:media_id/quiz_templates Create a new QuizTemplate
GET /api/media_management/media/:media_id/quiz_templates List all QuizTemplates
GET /api/media_management/quiz_templates/:id Return a quiz template
PATCH /api/media_management/quiz_templates/:id Update a quiz template
PUT /api/media_management/quiz_templates/:id Update a quiz template
DELETE /api/media_management/quiz_templates/:id Deletes a quiz template

Tweed Media Management Screen Cap Configs

Resource Description
GET /api/media_management/screen_cap_config Fetch the configuration for the screen capture client application

Tweed Media Management Screen Cap Launch Requests

Resource Description
POST /api/media_management/screen_cap_launch_requests Initiate a screen capture app launch request. Returns id of request and a launch status update URL.
POST /api/media_management/screen_cap_launch_requests/:id Update the app launch status.
PATCH /api/media_management/screen_cap_launch_requests/:id Update the app launch status.
PUT /api/media_management/screen_cap_launch_requests/:id Update the app launch status.
GET /api/media_management/screen_cap_launch_requests/:id Show the screen capture app launch status.
GET /api/media_management/screen_cap_launch_requests/:id/upload Respond to request for upload url
POST /api/media_management/screen_cap_launch_requests/:id/upload Respond to request for upload url
GET /api/media_management/screen_cap_launch_requests/:id/complete Respond to upload complete

Tweed Media Management Tags

Resource Description
GET /api/media_management/tags Lists all tags for the given media
POST /api/media_management/tags Creates a new tag for a given media
DELETE /api/media_management/tags/:id Deletes a tag for the given media and tag

Tweed Media Management Thumbnails

Resource Description
POST /api/media_management/media/:media_id/thumbnails Creates or replaces a custom thumbnail for a media file

Tweed Media Management Users

Resource Description
GET /api/media_management/search_users Search for users by name or email

Tweed Support Admin Accounts

Resource Description
GET /api/support_admin/accounts Returns a list of all account objects, filtered by query if provided.
GET /api/support_admin/accounts/count Returns a count of account objects
GET /api/support_admin/accounts/:id Returns an account object for a specific account
POST /api/support_admin/accounts Creates a new account object
PATCH /api/support_admin/accounts/:id Modifies an existing account object
PUT /api/support_admin/accounts/:id Modifies an existing account object

Tweed Support Admin Lti Keys

Resource Description
GET /api/support_admin/accounts/:account_id/lti_keys Returns a list of all LTI keys
GET /api/support_admin/lti_keys/:id Returns a specific LTI key
POST /api/support_admin/accounts/:account_id/lti_keys Creates a new LTI key for an account
DELETE /api/support_admin/lti_keys/:id Destroys a specific LTI key

Tweed Support Admin Users

Resource Description
GET /api/support_admin/accounts/:account_id/users Lists all users for the account
GET /api/support_admin/accounts/:account_id/users/:id Show the specified user
GET /api/support_admin/accounts/:account_id/users/count Returns a count of user objects
POST /api/support_admin/accounts/:account_id/users Create users when authenticated as a support admin
PATCH /api/support_admin/accounts/:account_id/users/:id Update a user as support admin
PUT /api/support_admin/accounts/:account_id/users/:id Update a user as support admin

Tweed User Management Notifications

Resource Description
GET /api/user_management/users/:user_id/notifications List all recent notifications sent to a given user

Tweed User Management Passwords

Resource Description
POST /api/user_management/users/passwords Sets a user's password to the given value
GET /api/user_management/users/verify/:token Verifies given token
POST /api/user_management/users/reset_password Sends a password reset email

Tweed User Management Users

Resource Description
GET /api/user_management/users Lists users for the account when authenticated as an account admin
GET /api/user_management/users/:id Show the specified user
GET /api/user_management/users/count Returns a count of user objects
POST /api/user_management/users Create users when authenticated as an account admin
PATCH /api/user_management/users/:id Update a user when authenticated as an account admin
PUT /api/user_management/users/:id Update a user when authenticated as an account admin
PUT /api/user_management/user/update_terms Update current user's latest terms of use hash agreement
PUT /api/user_management/user/update_settings Update current user's settings