List a dataset's files

A dataset, a filter of it or chosen scenarios as files (simforge.dataset-files/v1): signed links to the stored objects, a page at a time; format=urls for an aria2c link list; dryRun for counts and size. Files still being prepared are pending: ask for the same page again.

GET /api/v1/datasets/{id}/files

List a dataset's files

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/datasets/{id}/files \
  --header 'Authorization: Bearer <token>'

200

{
  "schema": "simforge.dataset-files/v1",
  "dataset": {
    "id": "<string>",
    "name": "<string>"
  },
  "selection": {
    "kind": "dataset"
  },
  "include": {
    "renders": {
      "presets": [
        "training"
      ],
      "modalities": [
        "rgb"
      ]
    },
    "labels": true,
    "groundTruth": true,
    "recordings": true,
    "generated": true
  },
  "scenarios": [
    {
      "id": "<string>",
      "revisionId": "<string>",
      "title": "<string>",
      "dir": "<string>",
      "map": {
        "versionId": "<string>",
        "name": "<string>",
        "sourceMapId": "<string>",
        "xodrSha256": "<string>"
      },
      "grade": {
        "tier": "<string>",
        "basis": "<string>"
      },
      "tags": [
        "<string>"
      ],
      "split": "<string>",
      "lineage": {
        "derivationKind": "<string>",
        "parentId": "<string>",
        "sourceRecordingSha256": "<string>",
        "source": {
          "dataset": "<string>",
          "logId": "<string>",
          "label": "<string>"
        }
      },
      "licence": "<string>",
      "simulation": {
        "simKey": "<string>",
        "engineSemVer": "<string>",
        "resolvedInputDigest": "<string>"
      },
      "recording": "<string>",
      "recordings": [
        "<string>"
      ],
      "renders": [
        {
          "id": "<string>",
          "preset": "training",
          "engine": "<string>",
          "source": "studio",
          "dir": "<string>",
          "files": [
            {
              "path": "<string>",
              "sha256": "<string>",
              "size": 1,
              "role": "<string>",
              "mediaType": "<string>",
              "sensorId": "<string>",
              "actorId": "<string>",
              "modality": "<string>"
            }
          ]
        }
      ],
      "generated": [
        {
          "dir": "<string>",
          "runId": "<string>",
          "lookId": "<string>",
          "seed": 1,
          "verdict": "accepted",
          "files": [
            {
              "path": "<string>",
              "sha256": "<string>",
              "size": 1,
              "mediaType": "<string>"
            }
          ]
        }
      ],
      "members": [
        {
          "path": "<string>",
          "role": "document",
          "sha256": "<string>",
          "size": 1
        }
      ]
    }
  ],
  "files": [
    {
      "path": "<string>",
      "role": "document",
      "mediaType": "<string>",
      "state": "ready",
      "sha256": "<string>",
      "size": 1,
      "url": "<string>",
      "urlExpiresAt": "<string>",
      "documentId": "<string>"
    }
  ],
  "excluded": [
    {
      "documentId": "<string>",
      "title": "<string>",
      "code": "<string>",
      "reason": "<string>",
      "path": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Query Parameters

q · string

Free-text search, as in the library's search box.

filter · string

Library filters: space-separated facet:value[,value] tokens, e.g. grade:A tag:cut-in.

sourceLog · string

Only the scenarios of one recorded drive.

ids · string

Exactly these scenarios, comma-separated document ids (POST the same fields for long lists).

include · string

Comma-separated: renders[:training|showcase|schematic], labels, gt, recordings, or scenarios alone; default renders:training.

passes · string

Keep only these render modalities (comma-separated).

cursor · string

Minimum string length: 1

limit · integer

Required range: 1 <= x <= 1000

format · enum<string>

urls: the whole selection as an aria2c input file of 24-hour links.

Available options: json, urls

dryRun · boolean

Counts and size of the whole selection; no links.

Response

200

application/json

A page of files (each a signed GET of the stored object, range-capable; ask again for fresh links), the dry-run summary, or (format=urls) the link list.

Option 1

Option 2

schema · enum<string> · required

Available options: simforge.dataset-files/v1

dataset · object · required

Show child attributes

selection · object · required

Option 1

Option 2

Option 3

Show child attributes

include · object · required

Show child attributes

scenarios · object[] · required

This page's scenarios.jsonl rows, by document id.

Show child attributes

files · object[] · required

Every file of this page's scenarios, and the recordings they bring.

Show child attributes

excluded · object[] · required

Show child attributes

nextCursor · string | null · required