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

Starts a new simulation session.

Request

Creates a new simulation session for the specified task. This includes: - Ensuring the AI tutor configuration exists - Initializing the conversation context with system prompts - Creating a unique conversation ID for the session

The API user acts on behalf of the end-user and must have appropriate access to the task.

Security
bearerAuth
Bodyapplication/jsonrequired
simulationTaskobject(SimulationTask)required
simulationTask.​idstringrequired

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

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

The task language.

Default "EN_US"
Enum"DE_CH""DE_DE""EN_US""EN_UK""FR_FR""IT_IT""ES_ES"
simulationTask.​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"
simulationTask.​problemStatementstringrequired

The problem statement of the task.

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

The object containing information about the media file.

tenantIdstringrequired

The ID of the tenant the simulation is associated with.

Example: "tenant_123"
curl -i -X POST \
  https://developers.taskbase.com/simulation/start \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "simulationTask": {
      "id": "sim_task_123",
      "type": "SIMULATION",
      "language": "EN_US",
      "title": "Customer Service Roleplay",
      "problemStatement": "Practice handling a customer complaint",
      "scenarioDescription": "You are a customer service representative. A customer is upset about a delayed order.",
      "initialMessage": "Hello, I need to speak with someone about my order!",
      "timeLimitInMinutes": 15
    },
    "tenantId": "tenant_123"
  }'

Responses

Simulation session response

Bodyapplication/json
idstringrequired

Unique identifier of the simulation session.

taskIdstringrequired

The task ID associated with this simulation session.

userIdinteger(int64)required

The user ID who started the simulation session.

transactionIdinteger(int64)

The transaction ID associated with this simulation session, if available.

tutorIdstringrequired

The ID of the tutor that provides the tutor interactions.

initialMessagesobject(SimulationConversation)required

Conversation data for simulation tasks.

initialMessages.​messagesArray of objects(SimulationMessage)
Response
application/json
{
  "id": "string",
  "taskId": "string",
  "userId": 0,
  "transactionId": 0,
  "tutorId": "string",
  "initialMessages": {
    "messages": [ … ]
  }
}

Tasks

Operations
Copyright © Taskbase AG. All rights reserved.