Skip to main content
Veryfront runs are durable, project-scoped executions. Tasks and workflows are definitions. A run is what executes one of those definitions.
  • A task run executes a task:<task-id> target.
  • A workflow run executes a workflow:<workflow-id> target.
  • A target names the capability being executed, for example task:knowledge-ingest or workflow:content-pipeline.
  • events are the canonical user-visible output stream.
  • The run record stores the terminal execution shape directly: target, input, config, output, error, logs, artifacts, duration_ms, and exit_code.
  • Runtime adapters such as process execution are implementation details.

​
Prerequisites

  • A Veryfront Cloud project and a VERYFRONT_API_TOKEN. Set VERYFRONT_PROJECT_ID or VERYFRONT_PROJECT_SLUG to identify the project (see Configuration).
  • A task or workflow definition the run should execute.

​
Setup

Use the runs SDK for one-off task and workflow execution: 
import { createRunsClient } from "veryfront/runs";

const runs = createRunsClient({
  authToken: process.env.VERYFRONT_API_TOKEN,
  projectReference: "dreamy-haven",
});
If you are already running inside a Veryfront request context, the client can also pick up request-scoped auth and project context automatically.

​
Create a task run

const accepted = await runs.createTaskRun({
  projectId: "22222222-2222-4222-8222-222222222222",
  name: "Sync data",
  target: "task:sync-data",
  config: { batchSize: 100 },
});

console.log(accepted.run.run_id);
console.log(accepted.run.status);

​
Create a workflow run

await runs.createWorkflowRun({
  projectId: "22222222-2222-4222-8222-222222222222",
  workflowId: "content-pipeline",
  target: "workflow:content-pipeline",
  input: { topic: "AI agents" },
});

​
Observe a run

Prefer events() for progress and user-visible activity: 
const events = await runs.events(accepted.run.run_id);

for (const entry of events.data) {
  console.log(entry.event_id, entry.event_type, entry.payload);
}
Read the current run summary: 
const run = await runs.get(accepted.run.run_id);
console.log(run.status);
console.log(run.output);
Cancel a non-terminal run: 
await runs.cancel(accepted.run.run_id);

​
List project runs

const page = await runs.list({ limit: 50 });
console.log(page.data.map((run) => run.run_id));

​
Scheduling

Schedules are definitions that create runs later. One-time and cron-style schedules belong to the platform scheduling API, not to task or workflow definitions. Scheduler and runtime-adapter details stay behind the platform API.

​
Verify it worked

After creating a run, watch its status and event stream: 
const accepted = await runs.createTaskRun({
  projectId: "22222222-2222-4222-8222-222222222222",
  name: "Test run",
  target: "task:sync-data",
});
console.log("created", accepted.run.run_id);

// Poll status until terminal
while (true) {
  const { status } = await runs.get(accepted.run.run_id);
  if (status === "completed" || status === "failed" || status === "cancelled") {
    break;
  }
  await new Promise((r) => setTimeout(r, 2000));
}

// Read the canonical event stream
const events = await runs.events(accepted.run.run_id);
for (const entry of events.data) {
  console.log(entry);
}
A working setup ends with status: "completed" and an event log whose entries describe the run.