Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
project_id
string
required
env_id
string
required

Body

application/json
commit
boolean

Commit the generated file to the env branch when the job succeeds. Default false: the file lands uncommitted in the worktree for review (manual runs see it; the deploy gate needs a commit).

component_id
string | null

Workforce component by numeric app id (the TIMBAL_APP_ID value; number or string). At least one of component_id / component_uid is required; when both are set they must resolve to the same component.

component_uid
string | null

Workforce component by manifest uid (the _id in timbal.yaml).

guidance
string | null

Optional steer for the generator, e.g. "focus on the refund flow".

kind
string | null

Job kind. Defaults to "generate_initial" (the only kind today; the vocabulary grows server-side without new endpoints).

Response

Job enqueued

Response body returned by the enqueue endpoint. The HTTP status is 202 Accepted — poll GET .../evals/jobs/{job_uid} for terminal state (a succeeded generate_initial job's file then shows up on GET .../evals/definitions with committed: false unless the job committed).

job_uid
string<uuid>
required
kind
string
required

Job kind (e.g. "generate_initial").

status
string
required

Always queued at accept time.