taskbridge-core/io.github.nikkiw.taskbridge.api/TaskBridgeClient

TaskBridgeClient

The main entry point for interacting with the TaskBridge backend.

Provides methods to start tasks, observe their progress via streaming events, submit actions for suspended tasks, and cancel active tasks.

Samples

val client =
    TaskBridgeClient.create(
        TaskBridgeConfig(
            baseUrl = "https://api.example.com",
            transportFactory =
                OkHttpTaskBridgeTransportFactory<Unit>(
                    OkHttpTaskBridgeTransportConfig(okHttpClient = OkHttpClient()),
                ),
            authHeaderProvider = { _, _ -> "Bearer your-token" },
        ),
    )

Functions

cancelTask

abstract suspend fun cancelTask(context: Ctx, taskId: String, reason: String? = null): CancelTaskResponse

Requests cancellation of an active task.

cancelTask

suspend fun TaskBridgeClient<Unit>.cancelTask(taskId: String, reason: String? = null): CancelTaskResponse

observeTaskEvents

abstract fun observeTaskEvents(context: Ctx, taskId: String, lastEventId: String? = null): Flow<TaskEvent>

Returns a Flow of events for a specific task.

observeTaskEvents

fun TaskBridgeClient<Unit>.observeTaskEvents(taskId: String, lastEventId: String? = null): Flow<TaskEvent>

startTaskJson

abstract suspend fun startTaskJson(context: Ctx, request: TaskCreateJsonRequest): TaskCreatedResponse

Starts a new task with JSON input.

startTaskJson

suspend fun TaskBridgeClient<Unit>.startTaskJson(request: TaskCreateJsonRequest): TaskCreatedResponse

Extension methods for TaskBridgeClient with Unit context to maintain backward compatibility.

startTaskMultipart

abstract suspend fun startTaskMultipart(context: Ctx, clientRequestId: String, taskType: String, inputJson: String?, metadataJson: String?, attachments: List<TaskBridgeMultipartAttachment>): TaskCreatedResponse

Starts a new task using multipart/form-data, typically for uploading files.

startTaskMultipart

suspend fun TaskBridgeClient<Unit>.startTaskMultipart(clientRequestId: String, taskType: String, inputJson: String?, metadataJson: String?, attachments: List<TaskBridgeMultipartAttachment>): TaskCreatedResponse

submitAction

abstract suspend fun submitAction(context: Ctx, taskId: String, action: TaskActionRequest): SubmitActionResponse

Submits a user action to resume a suspended task.

submitAction

suspend fun TaskBridgeClient<Unit>.submitAction(taskId: String, action: TaskActionRequest): SubmitActionResponse