Skip to main content
POST
Sample

Authorizations

Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Required key that makes retries return the original operation; use a new key for changed request bodies.

Path Parameters

session_id
string
required

Training session ID

Body

application/json
model_inputs
object[]
required

Model inputs to sample from

sampling_params
object

Optional sampling parameters

num_samples
integer
default:1

Number of completions to generate per prompt

Example:

1

prompt_logprobs
boolean
default:false

When true, also compute teacher-forced log-probabilities for the model input tokens and return them in SampleResult.prompt_logprobs.

Example:

false

topk_prompt_logprobs
integer
default:0

Number of most likely alternative tokens to return per model input token in SampleResult.topk_prompt_logprobs. 0 disables top-k prompt log-probabilities. Maximum 20.

Required range: 0 <= x <= 20
Example:

0

return_routed_experts
boolean
default:false

When true, enable reuse of the expert selections from sampled sequences during training. Only supported for mixture-of-experts models; ignored for other models.

Example:

false

Response

Async sample operation

id
string
required

Operation ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

status
enum<string>
default:TRAINING_OPERATION_STATUS_UNSPECIFIED
required

Operation status

Available options:
TRAINING_OPERATION_STATUS_UNSPECIFIED,
TRAINING_OPERATION_STATUS_PENDING,
TRAINING_OPERATION_STATUS_RUNNING,
TRAINING_OPERATION_STATUS_COMPLETED,
TRAINING_OPERATION_STATUS_FAILED
Example:

"TRAINING_OPERATION_STATUS_PENDING"

output
object

Result on success

error
object

Error details on failure