Skip to content
Download OpenAPI description
Languages
Servers
https://api.taskbase.com/
Operations
Operations
Operations
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.

tenantIdstring

Tenant identifier.

answerFreeformTextAnswer (object) or InTextFillInBlanksAnswer (object) or InTextChoicesAnswer (object) or MultipleChoiceAnswer (object) or MultipleResponsesAnswer (object) or SimulationAnswer (object)required

Base class for task answers. The concrete type depends on the task type.

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."
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
userIdstringrequired

User identifier.

Example: "student123"
curl -i -X POST \
  'https://api.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.

taskIdstring
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
userIdstring
Response
application/json
{ "result": { "feedback": [], "allAspects": [], "answer": {}, "points": {}, "sampleSolutions": [], "sampleSolution": {} }, "metaData": { "taskAction": "CREATED", "tenantId": "string", "taskLink": "string" }, "taskId": "string", "taskType": "FreeformTextFeedback", "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://api.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": {} } ]

Request

Security
bearerAuth
Path
taskIdstringrequired

The ID of the task to delete.

Query
tenantIdstring

Optional tenant identifier. Only needed if a task id exists across multiple tenants, to uniquely identify the task.

curl -i -X DELETE \
  'https://api.taskbase.com/tasks/{taskId}?tenantId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
messagestring
Example: "Task deleted successfully"
taskIdstring
Example: "task_waterloo"
tenantIdstring
Example: "tenant_123"
Response
application/json
{ "message": "Task deleted successfully", "taskId": "task_waterloo", "tenantId": "tenant_123" }
Operations
Operations