Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

datasetId
string
required

Dataset ID with prefix ds..

Pattern: ^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json
declaredSizeBytes
integer
required

Declared maximum upload size in bytes, from 1 byte to 1 GiB.

Required range: x <= 1073741824
filename
string
required

Name of the file being uploaded.

Minimum string length: 1
fields
object[]

Additional fields to create from matching keys in uploaded rows. Each complete row is also stored in "uploaded"; existing profile mappings still apply.

format
enum<string>
default:json

File format: "json" (a JSON array of row objects), "jsonl" (one JSON object per line) or "csv" (a header row naming the fields, one row per item; all values are ingested as strings). Defaults to "json".

Available options:
json,
csv,
jsonl

Response

Upload initiated

job
object
required

A dataset upload and its import status. After finalizing, poll until status is succeeded or failed.

uploadUrl
string
required

Signed URL for uploading file bytes with a PUT request and the x-ms-blob-type: BlockBlob header.