AssignmentOS Lecturer & TA User Guide
  • 👋Welcome to AssignmentOS!
  • 🖌️Create Custom Assignment
    • 1️⃣Select/Create Course
    • 2️⃣Choose Language/Framework
    • 3️⃣Set Deadline
    • 4️⃣Add Description & Starter Code
    • 5️⃣Define Grading Criteria
  • 🤖Automated Grading
    • Automated Test-Suite Scoring
    • Hidden Tests
    • Language/Framework Guides
      • Java (Maven)
      • Java (Gradle)
      • Kotlin (Maven)
      • Kotlin (Gradle)
      • Scala
      • JavaScript
      • TypeScript
      • Python
      • Ruby
      • Go
      • PHP
      • .NET
      • C++
      • Rust
      • Haskell
      • Elixir
      • Solidity
      • SQL
      • Swift
      • R
      • Web
      • Angular
      • AngularJS
      • React
      • React Native
      • Vue.js
      • Svelte
      • Elm
      • Rails
      • Django
      • WordPress
      • Terraform
      • Ansible
      • Powershell
      • Full-Stack
  • 📤Sending Assignments
    • From UI
    • From LMS
    • From API
  • 🔎Tracking
    • Student Tracking
    • Self-Tracking For Students
  • 👁️Reviewing Results
    • View Score & Status
    • View Report
    • View AI Feedback
  • 💬Feedback
    • Leaving Feedback In-App
    • Leaving Feedback in GitHub/GitLab Repo
  • 🤹Management
    • Manage Courses
      • Create New Course
      • Duplicate Course
      • Delete Course
    • Manage Assignments
      • Update Assignment
      • Delete Assignment
    • Manage Users
      • Add New Users
      • User Roles
      • Delete Users
  • 🤍White-Labelling
    • Editing Email Templates
    • Editing From Email Address
  • 💫LMS Integrations
    • Moodle
      • 1️⃣Connect AssignmentOS
      • 2️⃣Add Assignment
      • 3️⃣Access Assignment
        • As a Lecturer/TA
        • As a Student
    • Blackboard
    • Canvas
      • 1️⃣Connect AssignmentOS
      • 2️⃣Add Assignment
      • 3️⃣Access Assignment
        • As a Lecturer/TA
        • As Student
    • Brightspace
    • Schoology
  • 🔐Plagiarism Checker
    • Plagiarism Checker
  • 📊Analytics
    • Course Level
    • Assignment Level
  • ⚙️API
    • Workflow
    • Authentication
    • Endpoints
      • Load Assignments Endpoint
      • Start Assignment Endpoint
      • Load Assignment Instance Endpoint
    • Error Responses
  • ❓FAQ
    • Can I edit an assignment after I send it?
Powered by GitBook
On this page

Was this helpful?

  1. API

Authentication

PreviousWorkflowNextEndpoints

Last updated 1 year ago

Was this helpful?

In order to use the AssignmentOS API, you will first need to retrieve your API key from the AssignmentOS platform. To do this, log on to , head to the Integrations section and copy your AssignmentOS API key.

You then need to include this API key in the Authorization header of every request that you send to the AssignmentOS API. The API key needs to be prefixed by the string apiKey, e.g.

curl -X GET https://app.assignment-os.com/api/assignments -H 'Authorization: apiKey 5a355e5a-8e1b-4dab-a17c-4ab49fc267c3'
⚙️
AssignmentOS
Accessing Your AssignmentOS API key