Datasets

Preview a Roboflow import

Changed on

Validates a Roboflow API key and lists datasets available for import.

post/api/integrations/roboflow/preview

Request

  • Base URL
    https://platform.ultralytics.com
  • Auth
    HTTP bearer

Request body

apiKeystring

Roboflow API key

Example request

{
  "apiKey": "rf_your_api_key"
}

Response

Roboflow import plan

skippedCountinteger required
missingVersionCountinteger required
unsupportedCountinteger required
unresolvedCountinteger required
bytesTotalinteger required

Example response

{
  "newDatasets": [
    {
      "workspace": "my-workspace",
      "projectId": "vehicle-detection",
      "projectName": "Vehicle Detection",
      "projectType": "object-detection",
      "latestVersion": 1,
      "latestVersionName": "v1"
    }
  ],
  "importedDatasets": [
    {
      "workspace": "my-workspace",
      "projectId": "vehicle-detection",
      "projectName": "Vehicle Detection",
      "projectType": "object-detection",
      "latestVersion": 1,
      "latestVersionName": "v1"
    }
  ]
}

Changes