TasksResource: Manage, Version, and Execute Figranium Tasks

list

Retrieve every task in the workspace.

HTTP endpoint: GET /api/tasks
Signature: suspend fun list(options: RequestOptions = RequestOptions()): List<Task>

list_tasks.kt

val tasks = client.tasks.list()
println(tasks.size)

Returns a list of Task values.

listSummaries

Fetch a lightweight summary of all tasks.

HTTP endpoint: GET /api/tasks/list
Signature: suspend fun listSummaries(options: RequestOptions = RequestOptions()): List<TaskSummary>

list_summaries.kt

val summaries = client.tasks.listSummaries()
for (summary in summaries) {
    println("${summary.id} ${summary.name}")
}

Each TaskSummary contains id, name, and an optional description.

save

Create or update a task. Pass createVersion = true to snapshot the current version before saving.

HTTP endpoint: POST /api/tasks (with ?version=true when createVersion is set)
Signature: suspend fun save(task: Task, createVersion: Boolean = false, options: RequestOptions = RequestOptions()): Task

save_task.kt

val task = Task(
    name = "Search and extract",
    url = "https://example.com",
    mode = "agent",
    variables = mapOf(
        "query" to TaskVariable(type = "string", value = JsonPrimitive("figranium"))
    ),
    actions = listOf(
        Actions.waitFor("#search"),
        Actions.type("#search", value = variable("query")),
        Actions.press("Enter", selector = "#search"),
        Actions.getContent(selector = ".results", varName = "resultText")
    )
)

val saved = client.tasks.save(task, createVersion = true)
println(saved.id)

Returns the saved Task, including any server-generated id. For more about building actions, see Actions. For variable substitution, see Variables.

touch

Refresh a task’s last_opened timestamp without changing its definition.

HTTP endpoint: POST /api/tasks/{id}/touch
Signature: suspend fun touch(id: String, options: RequestOptions = RequestOptions()): Task

touch_task.kt

val updated = client.tasks.touch("task_123")

update

Apply a partial patch to an existing task.

HTTP endpoint: PATCH /api/tasks/{id}
Signature: suspend fun update(id: String, patch: JsonObject, options: RequestOptions = RequestOptions()): JsonObject

update_task.kt

val result = client.tasks.update(
    "task_123",
    patch = buildJsonObject {
        put("name", JsonPrimitive("Renamed task"))
        put("wait", JsonPrimitive(2000))
    }
)

delete

Remove a task by ID.

HTTP endpoint: DELETE /api/tasks/{id}
Signature: suspend fun delete(id: String, options: RequestOptions = RequestOptions()): JsonObject

delete_task.kt

val result = client.tasks.delete("task_123")

versions

List all saved versions for a task.

HTTP endpoint: GET /api/tasks/{id}/versions
Signature: suspend fun versions(id: String, options: RequestOptions = RequestOptions()): List<TaskVersion>

list_versions.kt

val versions = client.tasks.versions("task_123")
for (version in versions) {
    println("${version.id} ${version.timestamp} ${version.name}")
}

version

Retrieve a specific version snapshot.

HTTP endpoint: GET /api/tasks/{id}/versions/{versionId}
Signature: suspend fun version(id: String, versionId: String, options: RequestOptions = RequestOptions()): JsonObject

get_version.kt

val result = client.tasks.version("task_123", versionId = "v_456")

clearVersions

Delete all stored versions for a task.

HTTP endpoint: POST /api/tasks/{id}/versions/clear
Signature: suspend fun clearVersions(id: String, options: RequestOptions = RequestOptions()): JsonObject

clear_versions.kt

val result = client.tasks.clearVersions("task_123")

rollback

Restore a task to a previous version snapshot.

HTTP endpoint: POST /api/tasks/{id}/rollback
Signature: suspend fun rollback(id: String, versionId: String, options: RequestOptions = RequestOptions()): Task

rollback_task.kt

val restored = client.tasks.rollback("task_123", versionId = "v_456")
println(restored.id)

run

Execute a task and return its result. This is the public execution endpoint, reachable at /tasks/{id}/api.

HTTP endpoint: POST /tasks/{id}/api
Signature: suspend inline fun <reified T> run(id: String, input: ExecuteTaskOptions = ExecuteTaskOptions(), options: RequestOptions = RequestOptions()): ExecutionResult<T>

run_task.kt

val result: ExecutionResult<JsonElement> = client.tasks.run(
    "task_123",
    input = ExecuteTaskOptions(
        variables = mapOf("query" to JsonPrimitive("browser automation"))
    )
)
println(result.data)

The input object accepts variables, taskVariables, webhookUrl, and runId. For more about execution results and streaming, see ExecutionsResource. To learn about task variables and runtime substitution, see Variables and Actions. For per-request overrides, see RequestOptions.

Actions

Build action lists with typed helpers.

Variables

Declare and reference task variables.

Executions

Inspect the runs produced by task execution.

Models

Reference for Task, Action, TaskVariable, and supporting types.

Request options

Pass custom headers and per-request timeouts.

Errors

Handle FigraniumException responses.

Introduction

JavaScript SDK

Python SDK

Swift SDK

Kotlin SDK

TasksResource: Manage, Version, and Execute Figranium Tasks

Methods

Client shortcut

Actions

Variables

Executions

Models

Request options

Errors

​Methods

​Client shortcut

​Related resources

Actions

Variables

Executions

Models

Request options

Errors

Methods

Client shortcut

Related resources