Get started

Welcome to Taskbase, the API tool that excels at providing formative and personalized responses to learners.

Initial setup

Let’s learn how to use the Taskbase API.

If you do not have an account to access Taskbase Cockpit, please contact our Sales team to request access.

In the Taskbase Cockpit (refer to the link in your email), go to the sidebar and click on the Settings tab to generate your API key.

In this example, we will send a task with a learner answer to request feedback.

Steps

Before making requests, ensure you have your API key generated in the Settings tab in Taskbase Cockpit.

Step 1: Set parameters

Several parameters need to be configured. In the example below, we'll walk through how to set them up for a specific request to /feedback/compute.

curl -i -X POST \
  'https://api.taskbase.com/tasks/${taskId}/feedback/compute' \
  -H 'Authorization: Bearer <YOUR_UUID_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "some_anonymous_id",
    "taskType": "FREEFORM_TEXT",
    "taskDefinition": {
      "id": "your_id_as_string",
      "problemStatement": "When was the Battle of Waterloo?",
      "type": "FREEFORM_TEXT"
    },
    "answer": {
      "content": "The Battle of Waterloo was in 1815."
    }
  }'

These are the parameters and their definitions:

• userID: The learner’s ID, which can also be anonymous if preferred.
• taskType: The type of task, such as freeform text, in text fill in blanks, and in text choices tasks.
• taskDefinition: The task name along with its problem statement.
• answer: The response provided by the learner.
  
  

Step 2: Send the request

Call the API by passing the proper parameters to the /feedback endpoint.
There are several endpoints, and each one requires its own specific set of parameters.

This tutorial shows how to send a task and learner’s answer to request feedback. You can also make API calls to request feedback on tasks that have already been sent.

Common Feedback Workflows