Skip to main content
PATCH
Rename a fine-tuning job

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

jobId
string<uuid>
required

Fine-tuning job id.

Body

application/json
name
string

The run's new display name, trimmed, 1 to 120 characters; the tuned model takes it in model lists.

Required string length: 1 - 120

Response

OK

completedAt
null | string<date-time>
required
read-only

When the job reached a final status; null until then.

createdAt
string<date-time>
required
read-only
dataset
string
required
datasetProvenance
object
required
read-only

The dataset revision and split recorded when the job was created.

failure
object | null
required
read-only

Why the job failed; null unless status is failed.

jobId
string<uuid>
required
read-only
model
string
required
name
string
required

The run's display name.

Required string length: 1 - 120
progress
object
required
read-only
result
object
required
read-only

What the job produced. Both fields are null until the trainer saves a checkpoint; an evaluation-only job never has one.

settings
object
required

The run settings the job trains with.

startedAt
null | string<date-time>
required
read-only

When a worker started the job; null while it is queued.

status
enum<string>
required
read-only

queued until a worker starts it; succeeded, failed and cancelled are final.

Available options:
queued,
running,
succeeded,
failed,
cancelled
summary
object
required
read-only

Scores derived from the job's metrics, and the cost Tinker reports for the job.

updatedAt
string<date-time>
required
read-only