Skip to main content
POST
/
projects
/
{project_reference}
/
jobs
Create Job
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "target": "<string>",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "config": {},
  "timeout_seconds": 2,
  "backoff_limit": 1
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canonical_run_id": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cron_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "submitted",
  "target": "<string>",
  "config": {},
  "context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timeout_seconds": 123,
  "backoff_limit": 123,
  "exit_code": 123,
  "failed_reason": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>",
  "kind": "knowledge_ingest",
  "failure_detail": "<string>",
  "result_summary": {
    "kind": "knowledge_ingest",
    "state": "success",
    "requested_count": 1,
    "ingested_count": 1,
    "skipped_count": 1,
    "failed_count": 1
  },
  "result": {
    "kind": "knowledge_ingest",
    "version": 1,
    "metadata": {
      "requested_count": 1,
      "source_mode": "explicit_sources",
      "knowledge_path": "<string>"
    },
    "summary": {
      "requested_count": 1,
      "ingested_count": 1,
      "skipped_count": 1,
      "failed_count": 1
    },
    "ingested": [
      {
        "source": "<string>",
        "localSourcePath": "<string>",
        "outputPath": "<string>",
        "remotePath": "<string>",
        "slug": "<string>",
        "sourceType": "<string>",
        "summary": "<string>",
        "stats": {},
        "warnings": [
          "<string>"
        ]
      }
    ],
    "skipped": [
      {
        "source": "<string>",
        "localSourcePath": "<string>",
        "reason": "hidden_path",
        "message": "<string>"
      }
    ],
    "failed": [
      {
        "source": "<string>",
        "localSourcePath": "<string>",
        "reason": "parser_error",
        "message": "<string>"
      }
    ]
  }
}

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.

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

​
project_reference
string
required

Project slug or UUID

Body

application/json
​
name
string
required

Human-readable job name.

​
target
string
required

Task, workflow, or runtime target to execute.

​
environment_id
string<uuid>

Environment UUID to scope this job to.

​
branch_id
string<uuid>

Branch UUID for the project source snapshot. Omit for main.

​
batch_id
string<uuid>

Batch UUID used to group related jobs.

​
config
object

Arbitrary job configuration passed to the runtime target.

​
timeout_seconds
integer

Job timeout in seconds. Defaults to 300.

Required range: x >= 1
​
backoff_limit
integer

Retry count before the job is marked failed. Defaults to 3.

Required range: x >= 0

Response

Job created.

​
id
string<uuid>
required
​
canonical_run_id
string | null
required
Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9_-]+$
​
project_id
string<uuid>
required
​
environment_id
string<uuid> | null
required
​
branch_id
string<uuid> | null
required
​
cron_job_id
string<uuid> | null
required
​
batch_id
string<uuid> | null
required
​
name
string
required
​
status
enum<string>
required
Available options:
submitted,
working,
completed,
failed,
canceled
​
target
string
required
​
config
object
required
​
context_id
string<uuid> | null
required
​
timeout_seconds
number
required
​
backoff_limit
number
required
​
exit_code
number | null
required
​
failed_reason
string | null
required
​
started_at
string | null
required
​
completed_at
string | null
required
​
created_by
string<uuid> | null
required
​
created_at
string
required
​
updated_at
string
required
​
kind
enum<string> | null
required
Available options:
knowledge_ingest
​
failure_detail
string | null
required
​
result_summary
object
required
​
result
object
required