👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

File Upload REST API Guide

---0 icon: description: >- Explore API integration with Fiddler’s platform. Learn about file uploads, from single-part to multi-part options, and optimize your workflow effortlessly. hidden: false layout: title: visible: true description: visible: false tableOfContents: visible: true outline: visible: true pagination: visible: true

File Upload

PreviousModel REST API Guide NextCustom Metrics REST API Guide

Last updated 6 hours ago

Was this helpful?

Upload file in a single part

Uploads a file in a single part to Fiddler.

POST/v3/files/upload

Authorization

Body

file*string (binary)

Binary file object

Response

File uploaded successfully.

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

const response = await fetch('/v3/files/upload', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "text"
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "filename": "text",
    "type": "CSV",
    "status": "INITIATED",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "created_at": "2025-02-06T09:12:30.495Z",
    "updated_at": "2025-02-06T09:12:30.495Z"
  }
}

Initiate multi-part upload

Initiates a multi-part upload process for a large file to Fiddler.

POST/v3/files/multipart-init

Authorization

Body

filename*string

Name of the file uploaded by the user.

Response

Multi-part upload request initiated successfully.

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

const response = await fetch('/v3/files/multipart-init', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filename": "text"
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "filename": "text",
    "type": "CSV",
    "status": "INITIATED",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "created_at": "2025-02-06T09:12:30.495Z",
    "updated_at": "2025-02-06T09:12:30.495Z"
  }
}

Upload file a part of the file

Uploads a part of a large file to Fiddler as part of a multi-part upload process.

POST/v3/files/multipart-upload

Authorization

Body

file*string (binary)

Binary file object

file_id*string (uuid)

Unique file identifier

part_number*integer

Part number of the file in multi-part upload process.

Response

File part uploaded successfully.

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataobject

Request

const response = await fetch('/v3/files/multipart-upload', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "text",
      "file_id": "123e4567-e89b-12d3-a456-426614174000",
      "part_number": 1
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "part_id": 1
  }
}

Complete multi-part upload

Completes the multi-part upload process for a large file in Fiddler.

POST/v3/files/multipart-complete

Authorization

Body

file_idstring (uuid)

Unique file identifier

partsarray of object

Response

Multi-part upload request completed successfully.

Body

api_versionenum

API version.

2.03.0

kindenum

Type of response, indicating a normal response.

NORMAL

dataall of

Request

const response = await fetch('/v3/files/multipart-complete', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "parts": [
        {}
      ]
    }),
});
const data = await response.json();

Response

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "filename": "text",
    "type": "CSV",
    "status": "INITIATED",
    "created_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "updated_by": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "full_name": "text",
      "email": "hello@example.com"
    },
    "created_at": "2025-02-06T09:12:30.495Z",
    "updated_at": "2025-02-06T09:12:30.495Z"
  }
}