Skip to main content

Import

import {
  createRunsClient,
  CancelRunResponseSchema,
  CreateRunResponseSchema,
  RunEventListSchema,
  RunEventSchema,
  RunListSchema,
} from "veryfront/runs";

Examples

import { VeryfrontRunsClient } from "veryfront/runs";

const runs = new VeryfrontRunsClient({
  authToken: process.env.VERYFRONT_API_TOKEN,
  projectReference: "my-project",
});

const accepted = await runs.createTaskRun({
  projectId: "00000000-0000-4000-8000-000000000000",
  target: "task:sync-data",
  config: { batchSize: 100 },
});

const events = await runs.events(accepted.run.run_id);

Exports

Components

NameDescriptionSource
CancelRunResponseSchemaZod schema for a cancel-run response.source
CreateRunResponseSchemaZod schema for a create-run response.source
RunEventListSchemaZod schema for a paginated run-event response.source
RunEventSchemaZod schema for a run event.source
RunListSchemaZod schema for a paginated project-run response.source
RunSchemaZod schema for a canonical durable run.source

Functions

NameDescriptionSource
createRunsClientCreate a runs client.source

Classes

NameDescriptionSource
VeryfrontRunsClientPublic client for canonical durable runs.source

Types

NameDescriptionSource
CancelRunResponseResponse returned when a run is cancelled.source
CreateRunResponseResponse returned when a run is accepted.source
CreateTaskRunInputsource
CreateWorkflowRunInputsource
KnowledgeIngestByUploadIdsInputInput payload for knowledge ingest by upload IDs.source
KnowledgeIngestByUploadPathsInputInput payload for knowledge ingest by upload paths.source
KnowledgeIngestByUploadPrefixInputInput payload for knowledge ingest by upload prefix.source
ListRunEventsOptionssource
ListRunsOptionssource
ProjectScopedOptionsOptions accepted by project-scoped run requests.source
RunCanonical durable run.source
RunEventEvent emitted by a run.source
RunExecutionErrorError payload recorded for failed task and workflow runs.source
RunKindCanonical durable run kind.source
RunListPaginated project run response.source
RunOwnerCanonical durable run owner.source
RunRuntimeTargetKindRuntime target for a task or workflow run.source
RunRuntimeTargetOptionsRuntime target fields accepted by run creation APIs.source
RunStatusCanonical durable run status.source
RunTriggerKindTrigger kind recorded on scheduled or externally-started runs.source
VeryfrontRunsClientConfigConfiguration used by the Veryfront runs client.source