List Datasets

List Datasets

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/datasets \
  --header 'Authorization: Bearer <token>'

{
  "datasets": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "state": "STATE_UNSPECIFIED",
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "exampleCount": "<string>",
      "userUploaded": {},
      "evaluationResult": {
        "evaluationJobId": "<string>"
      },
      "transformed": {
        "sourceDatasetId": "<string>",
        "filter": "<string>",
        "originalFormat": "FORMAT_UNSPECIFIED"
      },
      "splitted": {
        "sourceDatasetId": "<string>"
      },
      "evalProtocol": {},
      "externalUrl": "<string>",
      "format": "FORMAT_UNSPECIFIED",
      "createdBy": "<string>",
      "updateTime": "2023-11-07T05:31:56Z",
      "sourceJobName": "<string>",
      "estimatedTokenCount": "<string>",
      "averageTurnCount": 123
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

GET

accounts

{account_id}

datasets

List Datasets

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/datasets \
  --header 'Authorization: Bearer <token>'

{
  "datasets": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "state": "STATE_UNSPECIFIED",
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "exampleCount": "<string>",
      "userUploaded": {},
      "evaluationResult": {
        "evaluationJobId": "<string>"
      },
      "transformed": {
        "sourceDatasetId": "<string>",
        "filter": "<string>",
        "originalFormat": "FORMAT_UNSPECIFIED"
      },
      "splitted": {
        "sourceDatasetId": "<string>"
      },
      "evalProtocol": {},
      "externalUrl": "<string>",
      "format": "FORMAT_UNSPECIFIED",
      "createdBy": "<string>",
      "updateTime": "2023-11-07T05:31:56Z",
      "sourceJobName": "<string>",
      "estimatedTokenCount": "<string>",
      "averageTurnCount": 123
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

Query Parameters

pageSize

integer<int32>

The maximum number of datasets to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.

pageToken

string

A page token, received from a previous ListDatasets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDatasets must match the call that provided the page token.

filter

string

Only model satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.

orderBy

string

A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "name".

readMask

string

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

Response

200 - application/json

A successful response.

datasets

Next ID: 24 · object[]

Show child attributes

datasets.name

string

datasets.displayName

string

datasets.createTime

string<date-time>

datasets.state

enum<string>

default:STATE_UNSPECIFIED

Available options:

STATE_UNSPECIFIED,

UPLOADING,

READY

datasets.status

Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object

Show child attributes

datasets.status.code

enum<string>

default:OK

The status code.

Available options:

OK,

CANCELLED,

UNKNOWN,

INVALID_ARGUMENT,

DEADLINE_EXCEEDED,

NOT_FOUND,

ALREADY_EXISTS,

PERMISSION_DENIED,

UNAUTHENTICATED,

RESOURCE_EXHAUSTED,

FAILED_PRECONDITION,

ABORTED,

OUT_OF_RANGE,

UNIMPLEMENTED,

INTERNAL,

UNAVAILABLE,

DATA_LOSS

datasets.status.message

string

A developer-facing error message in English.

datasets.exampleCount

string<int64>

datasets.userUploaded

object

datasets.evaluationResult

object

Show child attributes

datasets.evaluationResult.evaluationJobId

string

required

datasets.transformed

object

Show child attributes

datasets.transformed.sourceDatasetId

string

required

datasets.transformed.filter

string

datasets.transformed.originalFormat

enum<string>

default:FORMAT_UNSPECIFIED

Available options:

FORMAT_UNSPECIFIED,

CHAT,

COMPLETION,

RL

datasets.splitted

object

Show child attributes

datasets.splitted.sourceDatasetId

string

required

datasets.evalProtocol

object

datasets.externalUrl

string

datasets.format

enum<string>

default:FORMAT_UNSPECIFIED

Available options:

FORMAT_UNSPECIFIED,

CHAT,

COMPLETION,

RL

datasets.createdBy

string

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

datasets.updateTime

string<date-time>

The update time for the dataset.

datasets.sourceJobName

string

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

datasets.estimatedTokenCount

string<int64>

The estimated number of tokens in the dataset.

datasets.averageTurnCount

number<float>

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

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer<int32>

Create Dataset

Get Dataset

⌘I

API Reference

Inference

Deployments

Fine-tuning

Multimedia

Admin

Build SDK (Deprecated)

Authorizations

Path Parameters

Query Parameters

Response