Skip to main content
The Figranium Kotlin SDK is the official Kotlin client for the Figranium API. It is built on Kotlin coroutines, ships with kotlinx.serialization models for tasks and actions, and exposes execution streams as Flow. The SDK supports Android projects (API 23+) and also runs on the JVM. An optional figranium-appfunctions artifact adds Android AppFunctions integration for system assistants and agents (Android API 36+).

​
Highlights

Native Kotlin coroutines

Every method is suspend. Execution and selector streams surface as Flow<StreamEvent<JsonElement>> that you collect with standard flow operators.

Type-safe serialization

All request and response models use kotlinx.serialization. The SDK serializes and deserializes JSON automatically so you work with typed Kotlin classes.

Custom OkHttp client

Pass your own OkHttpClient for custom interceptors, certificate pinning, or test doubles. The SDK respects the caller-supplied client.

Cancellable streams

Cancelling the collecting coroutine cancels the underlying stream. executions.watch(executionId, intervalMillis) polls and emits only on status change, finishing when the run ends.

​
Package facts

​
What you can do with the SDK

  • Save, update, version, and roll back tasks with typed Task and Action values.
  • Run tasks with runtime variables, or call scrape, agent, and headful directly for one-off executions.
  • Stream live execution events and headful selector events as Flow.
  • Manage schedules, captures, cookies, and Cabinets.
  • Select a per-task Cabinet for intercepted downloads and build typed upload actions.
  • Open and inspect headful browser sessions.
  • Expose approved Figranium tasks to Android system assistants via AppFunctions (optional).

​
Where to go next

Installation

Add the Gradle dependency and confirm your environment can reach Figranium.

Quickstart

Build, save, and run a typed task in a few minutes.

Client configuration

Configure baseUrl, timeouts, custom OkHttpClient, and default headers.

Resources

Reference for every resource exposed on the Figranium client.