Skip to content
Download OpenAPI description
Languages
Servers

https://developers.taskbase.com/

Operations

Computes feedback for the provided task and answer

Request

Security
bearerAuth
Bodyapplication/json
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"
taskDefinitionobjectrequired

Freeform text task.

Example: {"id":"task_waterloo","problemStatement":"When was the Battle of Waterloo?","type":"FREEFORM_TEXT","sampleSolutions":[{"content":"The Battle of Waterloo was in 1815."}]}
taskDefinition.​idstringrequired

The task ID. This field should contain the task identifier used in the client's system.

taskDefinition.​typestringrequired

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
taskDefinition.​languagestring

The task language.

Default "EN_US"
Enum"DE_CH""DE_DE""EN_US""EN_UK""FR_FR""IT_IT""ES_ES"
taskDefinition.​titlestring

The task title. If left blank, the taskDefinition.id will be used as the title during implicit task creation or update.

Example: "my_task_title"
taskDefinition.​problemStatementstringrequired

The problem statement of the task.

Example: "When was the Battle of Waterloo?"
taskDefinition.​sampleSolutionstring
taskDefinition.​sampleSolutionsArray of objects(FreeformTextSampleSolution)
taskDefinition.​contextstring
taskDefinition.​resourceobject(FreeformTextResource)

The object containing information about the media file.

curl -i -X POST \
  https://developers.taskbase.com/feedback/compute \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "student123",
    "taskType": "FREEFORM_TEXT",
    "taskDefinition": {
      "id": "task_waterloo",
      "problemStatement": "When was the Battle of Waterloo?",
      "type": "FREEFORM_TEXT",
      "sampleSolutions": [
        {
          "content": "The Battle of Waterloo was in 1815."
        }
      ]
    },
    "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" }
Operations
Operations
Operations