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
| Name | Description | Source |
|---|---|---|
CancelRunResponseSchema | Zod schema for a cancel-run response. | source |
CreateRunResponseSchema | Zod schema for a create-run response. | source |
RunEventListSchema | Zod schema for a paginated run-event response. | source |
RunEventSchema | Zod schema for a run event. | source |
RunListSchema | Zod schema for a paginated project-run response. | source |
RunSchema | Zod schema for a canonical durable run. | source |
Functions
| Name | Description | Source |
|---|---|---|
createRunsClient | Create a runs client. | source |
Classes
| Name | Description | Source |
|---|---|---|
VeryfrontRunsClient | Public client for canonical durable runs. | source |
Types
| Name | Description | Source |
|---|---|---|
CancelRunResponse | Response returned when a run is cancelled. | source |
CreateRunResponse | Response returned when a run is accepted. | source |
CreateTaskRunInput | source | |
CreateWorkflowRunInput | source | |
KnowledgeIngestByUploadIdsInput | Input payload for knowledge ingest by upload IDs. | source |
KnowledgeIngestByUploadPathsInput | Input payload for knowledge ingest by upload paths. | source |
KnowledgeIngestByUploadPrefixInput | Input payload for knowledge ingest by upload prefix. | source |
ListRunEventsOptions | source | |
ListRunsOptions | source | |
ProjectScopedOptions | Options accepted by project-scoped run requests. | source |
Run | Canonical durable run. | source |
RunEvent | Event emitted by a run. | source |
RunExecutionError | Error payload recorded for failed task and workflow runs. | source |
RunKind | Canonical durable run kind. | source |
RunList | Paginated project run response. | source |
RunOwner | Canonical durable run owner. | source |
RunRuntimeTargetKind | Runtime target for a task or workflow run. | source |
RunRuntimeTargetOptions | Runtime target fields accepted by run creation APIs. | source |
RunStatus | Canonical durable run status. | source |
RunTriggerKind | Trigger kind recorded on scheduled or externally-started runs. | source |
VeryfrontRunsClientConfig | Configuration used by the Veryfront runs client. | source |