> ## Documentation Index
> Fetch the complete documentation index at: https://figranium.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# TasksResource: Manage and Run Figranium Tasks
> Reference for the TasksResource in the Figranium Swift SDK. List, create, update, version, and execute tasks with typed requests and responses using Swift concurrency.
The `TasksResource` on the Figranium Swift SDK is the primary way to manage tasks. Use it to list, create, update, version, and run tasks. Every method is `async throws` and accepts an optional `options` parameter for per-request overrides such as custom headers or timeouts. The client-level convenience `client.runTask(id:input:options:)` proxies directly to `client.tasks.run(id:input:options:)`.
```swift TasksResource.swift theme={null}
import Figranium
let client = Figranium(apiKey: "YOUR_API_KEY")
```
The SDK's model type `Task` shadows Swift's concurrency `Task`. Use `Swift.Task { }` or `Figranium.Task` to disambiguate when necessary.
## Methods
Retrieve every task in the workspace.
* **HTTP endpoint:** `GET /api/tasks`
* **Signature:** `func list(options: RequestOptions = .init()) async throws -> [Task]`
```swift list_tasks.swift theme={null}
let tasks = try await client.tasks.list()
print(tasks.count)
```
Returns an array of [`Task`](/docs/sdk/swift/models) structs.
Fetch a lightweight summary of all tasks.
* **HTTP endpoint:** `GET /api/tasks/list`
* **Signature:** `func listSummaries(options: RequestOptions = .init()) async throws -> [TaskSummary]`
```swift list_summaries.swift theme={null}
let summaries = try await client.tasks.listSummaries()
for summary in summaries {
print(summary.id, summary.name)
}
```
Each `TaskSummary` contains `id`, `name`, and an optional `description`.
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:** `func save(_ task: Task, createVersion: Bool = false, options: RequestOptions = .init()) async throws -> Task`
```swift save_task.swift theme={null}
let task = Figranium.Task(
name: "Search and extract",
url: "https://example.com",
mode: "agent",
variables: [
"query": .init(type: "string", value: .string("figranium"))
],
actions: [
Actions.waitFor("#search"),
Actions.type("#search", value: variable("query")),
Actions.press("Enter", selector: "#search"),
Actions.getContent(selector: ".results", varName: "resultText")
]
)
let saved = try await client.tasks.save(task, createVersion: true)
print(saved.id ?? "no id")
```
Returns the saved `Task`, including any server-generated `id`. For more about building actions, see [`Actions`](/docs/sdk/swift/actions). For variable substitution, see [`Variables`](/docs/sdk/swift/variables).
Refresh a task's `last_opened` timestamp without changing its definition.
* **HTTP endpoint:** `POST /api/tasks/{id}/touch`
* **Signature:** `func touch(_ id: String, options: RequestOptions = .init()) async throws -> Task`
```swift touch_task.swift theme={null}
let updated = try await client.tasks.touch("task_123")
```
Apply a partial patch to an existing task.
* **HTTP endpoint:** `PATCH /api/tasks/{id}`
* **Signature:** `func update(_ id: String, patch: JSONObject, options: RequestOptions = .init()) async throws -> JSONObject`
```swift update_task.swift theme={null}
let result = try await client.tasks.update("task_123", patch: [
"name": .string("Renamed task"),
"wait": .number(2000)
])
```
Remove a task by ID.
* **HTTP endpoint:** `DELETE /api/tasks/{id}`
* **Signature:** `func delete(_ id: String, options: RequestOptions = .init()) async throws -> JSONObject`
```swift delete_task.swift theme={null}
let result = try await client.tasks.delete("task_123")
```
List all saved versions for a task.
* **HTTP endpoint:** `GET /api/tasks/{id}/versions`
* **Signature:** `func versions(_ id: String, options: RequestOptions = .init()) async throws -> [TaskVersion]`
```swift list_versions.swift theme={null}
let versions = try await client.tasks.versions("task_123")
for version in versions {
print(version.id, version.timestamp, version.name ?? "")
}
```
Retrieve a specific version snapshot.
* **HTTP endpoint:** `GET /api/tasks/{id}/versions/{versionId}`
* **Signature:** `func version(_ id: String, versionID: String, options: RequestOptions = .init()) async throws -> JSONObject`
```swift get_version.swift theme={null}
let result = try await client.tasks.version("task_123", versionID: "v_456")
```
Delete all stored versions for a task.
* **HTTP endpoint:** `POST /api/tasks/{id}/versions/clear`
* **Signature:** `func clearVersions(_ id: String, options: RequestOptions = .init()) async throws -> JSONObject`
```swift clear_versions.swift theme={null}
let result = try await client.tasks.clearVersions("task_123")
```
Restore a task to a previous version snapshot.
* **HTTP endpoint:** `POST /api/tasks/{id}/rollback`
* **Signature:** `func rollback(_ id: String, versionID: String, options: RequestOptions = .init()) async throws -> Task`
```swift rollback_task.swift theme={null}
let restored = try await client.tasks.rollback("task_123", versionID: "v_456")
print(restored.id ?? "no id")
```
Generate a CSS selector for a task action using an AI prompt.
* **HTTP endpoint:** `POST /api/tasks/generate-selector`
* **Signature:** `func generateSelector(task: Task, actionIndex: Int, prompt: String, options: RequestOptions = .init()) async throws -> String`
```swift generate_selector.swift theme={null}
let selector = try await client.tasks.generateSelector(
task: task,
actionIndex: 0,
prompt: "Find the main search input field"
)
print(selector)
```
Returns the generated CSS selector string.
Generate a JavaScript extraction script from a description.
* **HTTP endpoint:** `POST /api/tasks/generate-script`
* **Signature:** `func generateScript(_ description: String, options: RequestOptions = .init()) async throws -> String`
```swift generate_script.swift theme={null}
let script = try await client.tasks.generateScript("Extract all product prices from the page")
print(script)
```
Returns the generated script string.
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:** `func run(_ id: String, input: ExecuteTaskOptions = .init(), options: RequestOptions = .init()) async throws -> ExecutionResult`
```swift run_task.swift theme={null}
let result: ExecutionResult = try await client.tasks.run(
"task_123",
input: .init(variables: ["query": .string("browser automation")])
)
print(result.data ?? .null)
```
The `input` object accepts `variables`, `taskVariables`, `webhookUrl`, and `runId`. For more about execution results and streaming, see [`ExecutionsResource`](/docs/sdk/swift/resources/executions). To learn about task variables and runtime substitution, see [`Variables`](/docs/sdk/swift/variables) and [`Actions`](/docs/sdk/swift/actions). For per-request overrides, see [`RequestOptions`](/docs/sdk/swift/request-options).