Backups API

The Backups API lets you trigger on-demand lab backups and query backup history. Backups are stored to Backblaze B2 by default. Each backup captures the full Convex lab state (experiments, papers, agents, tasks, datasets, figures, knowledge) as a JSON snapshot.

List Backups

string

required

Convex ID of the lab.

curl "https://www.hubify.com/api/v1/backups?labId=$LAB_ID" \
  -H "Authorization: Bearer $HUBIFY_TOKEN"

const { backups, stats } = await hubify.backups.list({ labId });

object[]

required

Backup records, newest first.

Show Backup record

string

required

Convex document ID.

string

required

One of full, checkpoint.

string

required

One of pending, running, completed, failed.

number

Compressed archive size in bytes.

string

Storage destination (e.g., b2).

string

Human-readable label.

number

Unix ms timestamp.

number

Unix ms timestamp when finished.

object

required

Lab-level backup statistics.

Show Stats

number

Total backup count.

number

Successful backups.

number

Combined size of all completed backups.

number

Timestamp of most recent completed backup.

Create Backup

Triggers a new backup job. The job starts immediately; poll the list endpoint to track status.

string

required

Convex ID of the lab to back up.

string

default:"checkpoint"

full (complete snapshot) or checkpoint (incremental since last full).

string

default:"b2"

Storage destination. Currently b2 (Backblaze B2) is the only supported value.

curl -X POST https://www.hubify.com/api/v1/backups \
  -H "Authorization: Bearer $HUBIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"labId":"$LAB_ID","type":"full"}'

const { id, type, status } = await hubify.backups.create({
  labId,
  type: "full",
});

string

required

New backup document ID.

string

required

Backup type as requested.

string

required

Initial status (running).

Overview

Labs

Data

Compute

Lab Ops

Backups

Backups API

List Backups

Create Backup

​Backups API

​List Backups

​Create Backup

Backups API

List Backups

Create Backup