Skip to main content
PATCH
Advance a fine-tuning job's lifecycle

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

agentId
string
required
jobId
string
required

Body

application/json
status
enum<string>
required

The lifecycle state to transition the job to (queued → running → succeeded/failed/cancelled). Illegal transitions return 422.

Available options:
queued,
running,
succeeded,
failed,
cancelled
Example:

"succeeded"

provider_job_id
string

The external provider-side tuning job id, recorded when the provider accepts the job.

Example:

"ftjob-9f27c1d4"

fine_tuned_model
string

The resulting fine-tuned model id — required on (or before) the succeeded transition; auto-registers the model into the agent's registry.

Example:

"ft:gpt-4o-mini-2026-09-18"

error
string

Failure reason to record on a failed transition (max 2000 chars).

Maximum string length: 2000
Example:

"Provider reported: dataset validation failed."

model_display_name
string

Display name for the custom model auto-registered on a succeeded transition (max 200 chars).

Maximum string length: 200
Example:

"Support tone tune v2"

Response

Successful response.