Donobu API (3.19.1)

Retrieves a paginated list of flows with optional filtering. Results are ordered by startedAt in descending order (newest first). Use the nextPageToken from the response to fetch subsequent pages.

Creates and starts a new Donobu flow. The flow begins executing asynchronously after creation. Poll GET /api/flows/{flowId} to track progress.

At a minimum, targetWebsite is required. For AUTONOMOUS mode, an overallObjective and a valid GPT configuration (either via the default agent or gptConfigNameOverride) are also required.

Retrieves the complete metadata for a specific flow, including its current state, configuration, execution statistics, and result.

Permanently deletes a flow and all associated data, including metadata, tool calls, screenshots, and video recordings. This operation cannot be undone.

A flow that is currently running cannot be deleted; cancel it first.

Updates the display name of an existing flow.

Converts a completed flow into a CreateFlowRequest payload suitable for deterministic replay. The returned object includes the original tool calls configured for sequential re-execution and can be submitted directly to POST /api/flows.

Generates a Playwright test script that replays the actions of a completed flow. The generated code uses the Donobu Playwright extension and can be executed independently as part of a test suite.

Generates a complete Playwright project structure containing test files for one or more flows, along with configuration and dependency files. The resulting project can be written to disk and executed directly with Playwright.

Retrieves the complete chronological history of tool calls executed within a flow. Each tool call includes the action name, input parameters, outcome, timing, the page URL at the time of execution, and a reference to a post-call screenshot (if available).

Submits a tool call for execution in an active flow. This is primarily used during INSTRUCT mode to direct the flow's next action. The proposed tool call is validated and queued; execution happens asynchronously.

The target flow must be actively running and the tool name must correspond to a valid, available tool whose parameters conform to its expected schema.

Retrieves detailed information about a single tool call within a flow, including its input parameters, outcome, timing, and associated metadata.

Retrieves a screenshot image captured during flow execution. The response is the raw image binary in PNG or JPEG format.

Retrieves the video recording of a flow execution in WebM format. Supports HTTP range requests for efficient streaming and seeking.

To stream the video, send a Range header (e.g. Range: bytes=0-1048575). The server will respond with 206 Partial Content and the requested byte range.

Retrieves the persisted browser storage state for a flow. This includes cookies, localStorage, and sessionStorage data captured from the browser context. The state is only available if the flow was configured with browser.persistState: true.

Returns the set of browser automation tools available for use within flows. Each tool includes its name, description, input JSON Schema, and whether it requires a GPT configuration to operate.

Use tool names from this list when specifying allowedTools or toolCallsOnStart in a CreateFlowRequest, or when proposing tool calls via POST /api/flows/{flowId}/tool-calls.

Retrieves a mapping of all Donobu agents to their assigned GPT configuration names. Agents without an assigned configuration will have a null value.

Retrieves the GPT configuration name currently assigned to a specific agent.

Assigns a GPT configuration to a specific agent. The referenced GPT configuration must already exist. Setting gptConfigName to null unlinks the agent from any configuration, which will prevent it from being used in autonomous flows.

Retrieves all stored GPT configurations. Sensitive fields such as API keys and secret access keys are automatically redacted in the response.

Retrieves a specific GPT configuration by name. Sensitive fields are automatically redacted.

Creates or updates a GPT configuration. The configuration is validated against the provider's requirements and a test request is made to verify connectivity and authentication before the configuration is saved.

Sensitive fields are redacted in the response — the original credentials are securely stored but never returned.

Permanently deletes a GPT configuration. Any agents that reference this configuration are automatically unlinked (their gptConfigName is set to null).

Retrieves all environment key-value pairs that are available for use by flows.

Retrieves a single environment datum by its key.

Creates a new environment datum or updates the value of an existing one.

Permanently removes an environment datum by its key.

A lightweight endpoint that returns HTTP 200 to confirm the server is running and accepting requests.

Returns the OpenAPI specification for the Donobu API. The response format depends on the Accept header: text/html returns an interactive HTML documentation page, otherwise the raw YAML specification is returned.