Skip to content

Taskbase Public API (0.9.0)

Download OpenAPI description
specification.json
specification.yaml
Languages
Servers
https://api.taskbase.com/

Feedback

Operations

Interactions

Operations

Simulation

Operations

Tasks

Operations

Tutor

Operations

Send a message to a tutor and receive a complete response

Request

Security
bearerAuth
Bodyapplication/jsonrequired

Chat request containing messages, tutor ID, and conversation context

messagesArray of objects(Message)
tutorIdstring
userIdstring
conversationIdstring
debugModeboolean
curl -i -X POST \
  https://api.taskbase.com/tutor/chat \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful operation

Bodyapplication/json
messagestring
messagesArray of strings
debugLogsArray of objects
Response
application/json
{
  "message": "string",
  "messages": [
    "string"
  ],
  "debugLogs": [
    { … }
  ]
}

Retrieve tutor configuration by ID

Request

Security
bearerAuth
Path
tutor_idstringrequired

The unique identifier of the tutor

curl -i -X GET \
  'https://api.taskbase.com/tutor/{tutor_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json
idstring
namestring
topic_idsArray of integers(int64)
initial_messagesArray of strings
descriptionstring
Response
application/json
{
  "id": "string",
  "name": "string",
  "topic_ids": [
    0
  ],
  "initial_messages": [
    "string"
  ],
  "description": "string"
}

Verify that the tutor API service is accessible

Request

Security
bearerAuth
curl -i -X GET \
  https://api.taskbase.com/tutor/healthcheck \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Service is healthy and accessible

Bodyapplication/json
statusstring
Response
application/json
{
  "status": "string"
}

Verify that the tutor chat functionality is operational

Request

Security
bearerAuth
curl -i -X GET \
  https://api.taskbase.com/tutor/healthcheck/chat \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Chat functionality is operational

Bodyapplication/json
messagestring
messagesArray of strings
debugLogsArray of objects
Response
application/json
{
  "message": "string",
  "messages": [
    "string"
  ],
  "debugLogs": [
    { … }
  ]
}

Stream tutor responses in real-time using Server-Sent Events

Request

Security
bearerAuth
Bodyapplication/jsonrequired

Chat request containing messages, tutor ID, and conversation context

messagesArray of objects(Message)
tutorIdstring
userIdstring
conversationIdstring
debugModeboolean
curl -i -X POST \
  https://api.taskbase.com/tutor/chat/stream \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful operation - SSE stream initiated

Bodytext/event-stream
string
Copyright © Taskbase AG. All rights reserved.