Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
veryfront/jobs

Jobs module for durable project-scoped background execution. Provides a public SDK surface for one-off jobs, cron jobs, batch summaries, job target discovery, and the canonical split between user-visible events and raw debugging logs.

​
Import

import {
  createJobsClient,
  CronJobSchema,
  CronJobStatusSchema,
  JobBatchResultSchema,
  JobBatchSchema,
  JobBatchStatusCountsSchema,
} from "veryfront/jobs";

​
Examples

import { VeryfrontJobsClient } from "veryfront/jobs";

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

const job = await jobs.knowledge.ingestByUploadIds({
  uploadIds: ["00000000-0000-0000-0000-000000000000"],
});

const events = await jobs.events(job.id);

​
Exports

​
Components

NameDescriptionSource
CronJobSchemaZod schema for cron job.source
CronJobStatusSchemaZod schema for cron job status.source
JobBatchResultSchemaZod schema for job batch result.source
JobBatchSchemaZod schema for job batch.source
JobBatchStatusCountsSchemaZod schema for job batch status counts.source
JobEventSchemaZod schema for job event.source
JobEventsResponseSchemaZod schema for job events response.source
JobKindSchemaZod schema for job kind.source
JobListItemSchemaZod schema for job list item.source
JobLogsResponseSchemaZod schema for job logs response.source
JobResultSchemaZod schema for job result.source
JobResultSummarySchemaZod schema for job result summary.source
JobSchemaZod schema for job.source
JobStatusSchemaZod schema for job status.source
JobTargetDefinitionSchemaZod schema for job target definition.source
JobTargetDefinitionsResponseSchemaZod schema for job target definitions response.source
KnowledgeIngestBatchSourceSchemaZod schema for knowledge ingest batch source.source
KnowledgeIngestBatchSourceWithMessageSchemaZod schema for knowledge ingest batch source with message.source
KnowledgeIngestFailedFileResultSchemaZod schema for knowledge ingest failed file result.source
KnowledgeIngestFileResultSchemaZod schema for knowledge ingest file result.source
KnowledgeIngestJobResultCountsSchemaZod schema for knowledge ingest job result counts.source
KnowledgeIngestJobResultMetadataSchemaZod schema for knowledge ingest job result metadata.source
KnowledgeIngestJobResultSchemaZod schema for knowledge ingest job result.source
KnowledgeIngestSkippedFileResultSchemaZod schema for knowledge ingest skipped file result.source
PageInfoSchemaZod schema for page info.source
PaginatedCronJobsResponseSchemaZod schema for paginated cron jobs response.source
PaginatedJobsResponseSchemaZod schema for paginated jobs response.source
ReservedJobTargetFamilySchemaZod schema for reserved job target family.source

​
Functions

NameDescriptionSource
createJobsClientCreate jobs client.source

​
Classes

NameDescriptionSource
VeryfrontJobsClientImplement veryfront jobs client.source

​
Types

NameDescriptionSource
CreateCronJobInputInput payload for create cron job.source
CreateJobInputInput payload for create job.source
CronJobPublic API contract for cron job.source
CronJobStatusPublic API contract for cron job status.source
JobPublic API contract for job.source
JobBatchPublic API contract for job batch.source
JobBatchResultResult returned from job batch.source
JobBatchStatusCountsPublic API contract for job batch status counts.source
JobEventEvent emitted for job.source
JobEventsResponseResponse payload for job events.source
JobKindPublic API contract for job kind.source
JobListItemPublic API contract for job list item.source
JobLogsResponseResponse payload for job logs.source
JobResultResult returned from job.source
JobResultSummaryPublic API contract for job result summary.source
JobStatusPublic API contract for job status.source
JobTargetDefinitionDefinition for job target.source
JobTargetDefinitionsResponseResponse payload for job target definitions.source
KnowledgeIngestBatchSourcePublic API contract for knowledge ingest batch source.source
KnowledgeIngestBatchSourceWithMessageMessage shape for knowledge ingest batch source with.source
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
KnowledgeIngestFailedFileResultResult returned from knowledge ingest failed file.source
KnowledgeIngestFileResultResult returned from knowledge ingest file.source
KnowledgeIngestJobOptionsOptions accepted by knowledge ingest job.source
KnowledgeIngestJobResultResult returned from knowledge ingest job.source
KnowledgeIngestSkippedFileResultResult returned from knowledge ingest skipped file.source
ListBatchJobsOptionsOptions accepted by list batch jobs.source
ListCronJobsOptionsOptions accepted by list cron jobs.source
ListJobEventsOptionsOptions accepted by list job events.source
ListJobsOptionsOptions accepted by list jobs.source
PaginatedCronJobsResponseResponse payload for paginated cron jobs.source
PaginatedJobsResponseResponse payload for paginated jobs.source
ProjectScopedOptionsOptions accepted by project scoped.source
ReservedJobTargetFamilyPublic API contract for reserved job target family.source
UpdateCronJobInputInput payload for update cron job.source
VeryfrontJobsClientConfigConfiguration used by veryfront jobs client.source
User guides:
  • jobs: Schedule and run background jobs
  • tasks: Define task targets for jobs
Architecture: