The trace ID to rate
- Stream tutor responses in real-time using Server-Sent Events
Submit a rating for a tutor trace
Send a message to a tutor and receive a complete response
Retrieve tutor configuration by ID
Verify that the tutor API service is accessible
Verify that the tutor chat functionality is operational
Stream tutor responses in...
Taskbase Public API (0.9.0)
Download OpenAPI description
Languages
Servers
https://api.taskbase.com/
- https://api.taskbase.com/trace/{traceId}/rate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.taskbase.com/trace/{traceId}/rate' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "success": true, "message": "string" }
- https://api.taskbase.com/tutor/chat
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.taskbase.com/tutor/chat \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "message": "string", "messages": [ "string" ], "debugLogs": [ { … } ], "traceId": "string" }
- https://api.taskbase.com/tutor/{tutor_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.taskbase.com/tutor/{tutor_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "id": "string", "name": "string", "topic_ids": [ 0 ], "initial_messages": [ "string" ], "description": "string" }
- https://api.taskbase.com/tutor/healthcheck
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.taskbase.com/tutor/healthcheck \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "status": "string" }
- https://api.taskbase.com/tutor/healthcheck/chat
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.taskbase.com/tutor/healthcheck/chat \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "message": "string", "messages": [ "string" ], "debugLogs": [ { … } ], "traceId": "string" }
- https://api.taskbase.com/tutor/chat/stream
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.taskbase.com/tutor/chat/stream \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'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.
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]"}