Skip to main content
POST
/
api
/
import
/
preview
Preview Import
curl --request POST \
  --url https://api.example.com/api/import/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "<string>",
  "username": "<string>",
  "key": "<string>",
  "token": "<string>"
}
'
{
  "provider": "<string>",
  "source": "<string>",
  "total_files": 123,
  "total_bytes": 123,
  "extension_counts": {},
  "sample_files": [
    "<string>"
  ],
  "warnings": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Cookies

antidote_session
string | null

Body

application/json
provider
enum<string>
required
Available options:
kaggle,
huggingface,
github
source
string
required

Dataset URL or identifier.

username
string | null
key
string | null
token
string | null

Response

Successful Response

provider
string
required
source
string
required
total_files
integer
required
total_bytes
integer | null
extension_counts
Extension Counts · object
sample_files
string[]
warnings
string[]