Skip to content
Download OpenAPI description
Languages
Servers
https://api.taskbase.com/
Operations
Operations
Operations
Operations
Operations

Request

Security
bearerAuth
Path
traceIdstringrequired

The trace ID to rate

Bodyapplication/jsonrequired

Rating request with score and optional comment

scoreinteger(int32)
commentstring
curl -i -X POST \
  'https://api.taskbase.com/trace/{traceId}/rate' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Rating submission result

Bodyapplication/json
successboolean
messagestring
Response
application/json
{ "success": true, "message": "string" }

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
sessionIdstring
debugModeboolean
userobject(ApiEndUser)

User details

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
traceIdstring
Response
application/json
{ "message": "string", "messages": [ "string" ], "debugLogs": [ {} ], "traceId": "string" }

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
traceIdstring
Response
application/json
{ "message": "string", "messages": [ "string" ], "debugLogs": [ {} ], "traceId": "string" }

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
sessionIdstring
debugModeboolean
userobject(ApiEndUser)

User details

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

Each event in the stream may contain the following fields:

  • event: Event type (MESSAGE, BOUNDARY, ERROR, TRACE, DEBUG, DONE)
  • id: Optional event ID
  • data: JSON-encoded payload specific to the event type
  • retry: Optional reconnection time in milliseconds

Events are separated by a blank line and follow the SSE specification.

Bodytext/event-stream
string
Response
text/event-stream

sseStreamExample

event: MESSAGE
data: {"text":"Hello! Let’s work through this step by step."}

event: BOUNDARY
data: {"text":"<MESSAGE_BOUNDARY>"}

event: TRACE
data: {"text":"trace_9f2c1b87"}

event: DEBUG
data: {"text":"debug_logs","list":[{"tool":"search","query":"binary trees"},{"decision":"explain_with_example"}]

event: ERROR
data: {"text":"An unexpected error occurred while generating the response"}

event: DONE
data: {"text":"[DONE]"}
Operations