Taskbase API (0.9.0)

Here is the OpenAPI specification for our stable public endpoints.

Download OpenAPI description

specification.json

specification.yaml

Overview

URL https://redirect.taskbase.com/help-center

License Copyright Taskbase

Servers

Default server

https://api.taskbase.com/

Feedback

Endpoints for working with feedback.

Operations

Aspects

Endpoints for working with Aspects.

Operations

Returns all relevant Aspects for a given task.

Request

This endpoint returns all relevant Aspects for a given task.

NOTE: This endpoint is in the alpha stage and its structure may change.

Bodyapplication/json

tenantIdstringrequired

The identifier of the tenant where the target task, specified in the taskDefinition, will be stored or searched for. If not provided the domain's default tenant will be used. Ensure that the API user has the necessary permissions on the target tenant to create or update a task. If not, an error-response of type MISSING_PERMISSIONS will be returned.

Example: "product_123"

taskDefinitionobjectrequired

taskDefinition.idstringrequired

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

Example: "your_id_as_string"

taskDefinition.problemStatementstringrequired

The problem statement of the task.

Example: "When was the Battle of Waterloo?"

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"

Discriminator

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

The task language.

Default "EN_US"

Enum"DE_CH""DE_DE""EN_US""EN_UK""FR_FR""IT_IT""ES_ES"

taskDefinition.sampleSolutionsArray of objects

taskDefinition.contextstring

Context, such as background knowledge or additional information, required to solve the task.

Default ""

taskDefinition.resourceobject

The object containing information about the media file.

taskDefinition.sampleSolutionstringDeprecated

The single answer to the problem statement that is considered correct.

NOTE: This field is deprecated and will eventually be removed in favor of the sampleSolutions array.

Default ""

curl -i -X POST \
  https://api.taskbase.com/tasks/aspects/compute \
  -H 'Authorization: Bearer <YOUR_UUID_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "product_123",
    "taskDefinition": {
      "id": "your_id_as_string",
      "problemStatement": "When was the Battle of Waterloo?",
      "type": "FREEFORM_TEXT"
    }
  }'

Responses

successful operation

Bodyapplication/jsonArray [

namestringrequired

The Aspect name.

Example: "Present 3rd person singular of regular verbs."

descriptionstringrequired

The Aspect description.

Example: "A learner can correctly form the present 3rd person singular of regular verbs."

typestringrequired

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

Enum"CONCEPT""MISCONCEPTION"

aspectGroupobject

The group to which the Aspect belongs.

]

Response

application/json

[
  {
    "name": "Present 3rd person singular of regular verbs.",
    "description": "A learner can correctly form the present 3rd person singular of regular verbs.",
    "type": "CONCEPT",
    "aspectGroup": { … }
  }
]