Prepare Signed-URL Upload

Get a signed URL for uploading a large dataset file.

POST /datasets/upload

Prepare Signed-URL Upload

cURL

curl --request POST \
  --url https://api.woodwide.ai/datasets/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset_name": "large_dataset",
  "file": {
    "filename": "large_data.csv",
    "bytes": 50000000,
    "content_type": "text/csv"
  }
}
'

import requests

url = "https://api.woodwide.ai/datasets/upload"

payload = {
    "dataset_name": "large_dataset",
    "file": {
        "filename": "large_data.csv",
        "bytes": 50000000,
        "content_type": "text/csv"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dataset_name: 'large_dataset',
    file: {filename: 'large_data.csv', bytes: 50000000, content_type: 'text/csv'}
  })
};

fetch('https://api.woodwide.ai/datasets/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.woodwide.ai/datasets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dataset_name' => 'large_dataset',
    'file' => [
        'filename' => 'large_data.csv',
        'bytes' => 50000000,
        'content_type' => 'text/csv'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.woodwide.ai/datasets/upload"

	payload := strings.NewReader("{\n  \"dataset_name\": \"large_dataset\",\n  \"file\": {\n    \"filename\": \"large_data.csv\",\n    \"bytes\": 50000000,\n    \"content_type\": \"text/csv\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.woodwide.ai/datasets/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"large_dataset\",\n  \"file\": {\n    \"filename\": \"large_data.csv\",\n    \"bytes\": 50000000,\n    \"content_type\": \"text/csv\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.woodwide.ai/datasets/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_name\": \"large_dataset\",\n  \"file\": {\n    \"filename\": \"large_data.csv\",\n    \"bytes\": 50000000,\n    \"content_type\": \"text/csv\"\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "dataset": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "version_id": "a1b2c3d4-0000-0000-0000-000000000002",
    "version_number": 1
  },
  "job_id": "a1b2c3d4-0000-0000-0000-000000000003",
  "upload": {
    "filename": "large_data.csv",
    "bytes": 50000000,
    "content_type": "text/csv",
    "upload_url": "https://storage.example.com/upload?signature=..."
  }
}

{
  "detail": "Not authenticated"
}

{
  "detail": "Forbidden"
}

{
  "detail": "Not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Rate limit exceeded. Retry after a short delay."
}

Upload the file directly to the returned signed URL, then call POST /datasets/{dataset_version_id}/complete to trigger ingestion.

Supports an Idempotency-Key header to safely retry requests.

Authorizations

Authorization · string · header · required

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

Headers

Idempotency-Key · string | null

Body

application/json

Request to prepare a signed-URL dataset upload.

file · DatasetUploadFile · object · required

File metadata for signed-URL upload.

Show child attributes

dataset_name · string

dataset_id · string<uuid>

description · string | null

override · boolean · default: false

When true, replaces the data in the current version instead of creating a new version. Defaults to false.

Response

201

application/json

Successful Response

Response with signed upload URL.

dataset · DatasetVersionRef · object · required

Dataset version reference.

Show child attributes

job_id · string<uuid> · required

upload · DatasetUploadTarget · object · required

Target for signed-URL upload.

Show child attributes