Sign in

v1

latestOpenAPI 3.1.02026-07-26106201349.6 KB
Gateway

Get Dataset

get/v1/accounts/{account_id}/datasets/{dataset_id}

Path parameters

account_idstring required

The Account Id

dataset_idstring required

The Dataset Id

Query parameters

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

namestring
displayNamestring
createTimestring date-time
state'STATE_UNSPECIFIED' | 'UPLOADING' | 'READY'
exampleCountstring int64
userUploadedGatewayUserUploaded
evalProtocolGatewayEvalProtocol
externalUrlstring
format'FORMAT_UNSPECIFIED' | 'CHAT' | 'COMPLETION' | 'RL'
createdBystring

The email address of the user who initiated this fine-tuning job.

updateTimestring date-time

The update time for the dataset.

sourceJobNamestring

The resource name of the job that created this dataset (e.g., batch inference job). Used for lineage tracking to understand dataset provenance.

estimatedTokenCountstring int64

The estimated number of tokens in the dataset.

averageTurnCountnumber float

An estimate of the average number of turns per sample in the dataset.

encryptionState'ENCRYPTION_STATE_UNSPECIFIED' | 'ENCRYPTION_STATE_PLAINTEXT' | 'ENCRYPTION_STATE_CMEK'

EncryptionState is the authoritative, per-resource CMEK marker: the single source of truth for whether a resource's customer-data artifacts are encrypted. It is stamped at resource creation from the owning account's CMEK config and is immutable for the resource's life, so a resource always reads back with the state it was created under regardless of the account's current flag. The encrypt-on-write / decrypt-on-read decision for the resource's data keys off this field.

  • ENCRYPTION_STATE_UNSPECIFIED: Unstamped/legacy rows that predate CMEK. Treated as PLAINTEXT.
  • ENCRYPTION_STATE_PLAINTEXT: Customer-data artifacts are stored as plaintext (Fireworks-owned, no CMEK).
  • ENCRYPTION_STATE_CMEK: Customer-data artifacts are CMEK-encrypted; reads MUST decrypt (fail-closed).