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
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).

rev
string | null

Git rev to extract when source = "git" (branch, tag, or SHA). Defaults to the env's tracked branch. Rejected when source = "worktree".

source
enum<string>

worktree (default) or git. Worktree includes uncommitted evals; git is a clean extract at rev.

Available options:
worktree,
git

Response

Eval run started

eval_run_id
string
required

Id of the created eval run. Stream GET .../evals/runs/{eval_run_id}/events or poll GET .../evals/runs/{eval_run_id}.

status
string
required

Always running at accept time.