Skip to main content
POST
Create prompt-tuning job

Authorizations

Authorization
string
header
required

Create an API key in the console.

Headers

idempotency-key
string | null

Body

application/json
dataset_id
string
required
Pattern: ^ds_[a-f0-9]{24}$
decision
string | null
Required string length: 1 - 128
model
string | null
Required string length: 1 - 140
effort
enum<string>
default:standard
Available options:
standard,
thorough
max_price_usd
string | null

The most you agree to pay for this job, in USD, such as the price you were shown. It is a decimal string, such as "2.500000000", never a JSON number, so no precision is lost: a number is refused with invalid_request, naming this field. If it costs more when it is admitted, it is refused with price_changed and nothing is held.

Pattern: ^\d{1,9}(\.\d{1,9})?$

Response

Successful Response

id
string
required
object
string
required
Allowed value: "prompt_tuning.job"
status
enum<string>
required
Available options:
queued,
running,
cancelling,
succeeded,
failed,
cancelled
dataset_id
string
required
model
string
required
decision
string
required
effort
enum<string>
required
Available options:
standard,
thorough
price_usd
string
required

The job's fee, as exact USD.

charge
enum<string>
required

What the fee is doing: held while the job runs, charged for a proven improvement or a rerun, released otherwise.

Available options:
free,
reserved,
charged,
released
test_looks
integer
required
progress
PromptProgress · object | null
required
result
PromptResult · object | null
required
created_at
number
required
updated_at
number
required
error
string
label_issues_dismissed_at
number

When you dismissed its label issues, so its dataset no longer lists them.