Skip to content

Taskbase Public API (0.9.0)

Download OpenAPI description
specification.json
specification.yaml
Languages
Servers

https://developers.taskbase.com/

Feedback

Operations

Interactions

Operations

Simulation

Operations

Tasks

Operations

Computes feedback for an existing task.

Request

Security
bearerAuth
Path
taskIdstringrequired

The ID of the task.

Bodyapplication/jsonrequired
metaDataobject(FeedbackRequestMetaData)

The object containing metadata related to the learner interaction.

taskTypestringrequired

Defines the type of the task. Can be used by deserialization tools to instantiate the correct sub-type.

Enum"FREEFORM_TEXT""IN_TEXT_FILL_IN_BLANKS""IN_TEXT_CHOICES""MULTIPLE_CHOICE""MULTIPLE_RESPONSES""SIMULATION"
Example: "FREEFORM_TEXT"
Discriminator
tenantIdstring

Tenant identifier.

answerFreeformTextAnswer (object) or InTextFillInBlanksAnswer (object) or InTextChoicesAnswer (object) or MultipleChoiceAnswer (object) or MultipleResponsesAnswer (object) or SimulationAnswer (object)required
Example: {"content":"The Battle of Waterloo was in 1815."}
One of:

Answer for freeform text tasks.

answer.​contentstring
Example: "The Battle of Waterloo was in 1815."
userIdstringrequired

User identifier.

Example: "student123"
curl -i -X POST \
  'https://developers.taskbase.com/tasks/{taskId}/feedback/compute' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "student123",
    "taskType": "FREEFORM_TEXT",
    "answer": {
      "content": "The Battle of Waterloo was in 1815."
    }
  }'

Responses

Successful operation

Bodyapplication/json
resultobject
metaDataobject(FeedbackMetaData)

The object containing metadata about the performed operation, along with helpful debugging information. Designed to simplify the integration process and does not include any production-related details that should be visible to the end user.

taskTypestring

Defines the type of the task. Can be used by deserialization tools to instantiate the correct sub-type.

Enum"FREEFORM_TEXT""IN_TEXT_FILL_IN_BLANKS""IN_TEXT_CHOICES""MULTIPLE_CHOICE""MULTIPLE_RESPONSES""SIMULATION"
Discriminator
taskIdstring
userIdstring
Response
application/json
{
  "result": {
    "allAspects": [ … ],
    "feedback": [ … ],
    "points": { … },
    "answer": { … },
    "sampleSolutions": [ … ],
    "sampleSolution": { … }
  },
  "metaData": {
    "taskAction": "CREATED",
    "tenantId": "string",
    "taskLink": "string"
  },
  "taskType": "FreeformTextFeedback",
  "taskId": "string",
  "userId": "string"
}

Returns all relevant Aspects for a given task.

Request

Security
bearerAuth
Bodyapplication/jsonrequired
tenantIdstring
Example: "tenant_123"
taskDefinitionobject(Task)
curl -i -X POST \
  https://developers.taskbase.com/tasks/aspects/compute \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "tenant_123",
    "taskDefinition": {
      "id": "task_waterloo",
      "problemStatement": "When was the Battle of Waterloo?",
      "type": "FREEFORM_TEXT",
      "sampleSolutions": [
        {
          "content": "The Battle of Waterloo was in 1815."
        }
      ]
    }
  }'

Responses

Successful operation

Bodyapplication/jsonArray [
namestring
descriptionstring
typestring

Indicates whether an Aspect represents a misconception (wrong aspect) or a concept (correct aspect).

Enum"CONCEPT""MISCONCEPTION"
aspectGroupobject(AspectGroup)

The group to which the Aspect belongs.

]
Response
application/json
[
  {
    "name": "string",
    "description": "string",
    "type": "CONCEPT",
    "aspectGroup": { … }
  }
]
Copyright © Taskbase AG. All rights reserved.