TasksResource: Manage and Run Figranium Tasks

list

Retrieve every task in the workspace.

HTTP endpoint: GET /api/tasks
Signature: list(*, options=None) -> List[Task]

list_tasks.py

tasks = client.tasks.list()
print(len(tasks))

Returns a list of Task objects.

list_summaries

Fetch a lightweight summary of all tasks.

HTTP endpoint: GET /api/tasks/list
Signature: list_summaries(*, options=None) -> {"tasks": List[TaskSummary]}

list_summaries.py

result = client.tasks.list_summaries()
for t in result["tasks"]:
    print(t["id"], t["name"])

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

save

Create or update a task. Pass create_version=True to snapshot the current version before saving.

HTTP endpoint: POST /api/tasks (with ?version=true when create_version is set)
Signature: save(task, *, create_version=False, options=None) -> Task

save_task.py

from figranium import actions, variable, Task

task: Task = {
    "name": "Search and extract",
    "url": "https://example.com",
    "mode": "agent",
    "variables": {
        "query": {"type": "string", "value": "figranium"},
    },
    "actions": [
        actions.wait_for("#search"),
        actions.type("#search", variable("query")),
        actions.press("Enter", "#search"),
        actions.get_content(".results", "resultText"),
    ],
}

saved = client.tasks.save(task, create_version=True)
print(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: touch(task_id, *, options=None) -> Task

touch_task.py

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

update

Apply a partial patch to an existing task.

HTTP endpoint: PATCH /api/tasks/{id}
Signature: update(task_id, patch, *, options=None) -> {"id": str, "updatedAt": int, "status": str, "task": Task}

update_task.py

result = client.tasks.update("task_123", {
    "name": "Renamed task",
    "wait": 2000,
})
print(result["updatedAt"])

delete

Remove a task by ID.

HTTP endpoint: DELETE /api/tasks/{id}
Signature: delete(task_id, *, options=None) -> {"id": str, "deleted": bool, "message": Optional[str]}

delete_task.py

result = client.tasks.delete("task_123")
print(result["deleted"], result.get("message"))

versions

List all saved versions for a task.

HTTP endpoint: GET /api/tasks/{id}/versions
Signature: versions(task_id, *, options=None) -> {"versions": List[TaskVersion]}

list_versions.py

result = client.tasks.versions("task_123")
for v in result["versions"]:
    print(v["id"], v["timestamp"], v["name"])

version

Retrieve a specific version snapshot.

HTTP endpoint: GET /api/tasks/{id}/versions/{versionId}
Signature: version(task_id, version_id, *, options=None) -> {"snapshot": Task, "metadata": {"id": str, "timestamp": int}}

get_version.py

result = client.tasks.version("task_123", "v_456")
print(result["metadata"]["timestamp"], result["snapshot"]["name"])

clear_versions

Delete all stored versions for a task.

HTTP endpoint: POST /api/tasks/{id}/versions/clear
Signature: clear_versions(task_id, *, options=None) -> {"success": bool}

clear_versions.py

result = client.tasks.clear_versions("task_123")

rollback

Restore a task to a previous version snapshot.

HTTP endpoint: POST /api/tasks/{id}/rollback
Signature: rollback(task_id, version_id, *, options=None) -> Task

rollback_task.py

restored = client.tasks.rollback("task_123", "v_456")
print(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: run(task_id, input=None, *, options=None) -> ExecutionResult

run_task.py

result = client.tasks.run("task_123", {
    "variables": {"query": "browser automation"},
})
print(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.

JavaScript SDK

Python SDK

Swift SDK

TasksResource: Manage and Run Figranium Tasks

Methods

​Methods

Methods