Upload a file - Steuerboard Documentation

Upload a file

curl --request POST \
  --url https://api.steuerboard.com/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-client-id: <x-client-id>' \
  --form workspaceId=cmf41ajzv003706un4i99q19z \
  --form file='@example-file' \
  --form labelIds=cmf41ajzv003706un4i99q19z \
  --form name=document.pdf \
  --form folderId=cmf41ajzv003706un4i99q19z \
  --form taskId=cmf41ajzv003706un4i99q19z

import requests

url = "https://api.steuerboard.com/v1/files"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "workspaceId": "cmf41ajzv003706un4i99q19z",
    "labelIds": "cmf41ajzv003706un4i99q19z",
    "name": "document.pdf",
    "folderId": "cmf41ajzv003706un4i99q19z",
    "taskId": "cmf41ajzv003706un4i99q19z"
}
headers = {
    "x-client-id": "<x-client-id>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('workspaceId', 'cmf41ajzv003706un4i99q19z');
form.append('file', '<string>');
form.append('labelIds', 'cmf41ajzv003706un4i99q19z');
form.append('name', 'document.pdf');
form.append('folderId', 'cmf41ajzv003706un4i99q19z');
form.append('taskId', 'cmf41ajzv003706un4i99q19z');

const options = {
  method: 'POST',
  headers: {'x-client-id': '<x-client-id>', Authorization: 'Bearer <token>'}
};

options.body = form;

fetch('https://api.steuerboard.com/v1/files', 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.steuerboard.com/v1/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "x-client-id: <x-client-id>"
  ],
]);

$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.steuerboard.com/v1/files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--")

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

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.steuerboard.com/v1/files")
  .header("x-client-id", "<x-client-id>")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.steuerboard.com/v1/files")

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

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--"

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

{
  "id": "cmf41ajzv003706un4i99q19z",
  "documentDate": "2021-01-01T00:00:00Z",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "name": "document.pdf",
  "mimetype": "application/pdf",
  "size": 1024,
  "workspaceId": "cmf41ajzv003706un4i99q19z",
  "createdById": "cmf41ajzv003706un4i99q19z",
  "taskId": "cmf41ajzv003706un4i99q19z",
  "folderId": "cmf41ajzv003706un4i99q19z",
  "labelIds": [
    "cmf41ajzv003706un4i99q19z"
  ]
}

{
  "type": "bad_request",
  "message": "<string>"
}

{
  "status_code": 401,
  "type": "auth_error",
  "code": "unauthorized",
  "message": "<string>"
}

{
  "type": "auth_error",
  "message": "<string>"
}

{
  "type": "bad_request",
  "message": "<string>"
}

{
  "success": false,
  "error": {
    "name": "ValidationError",
    "issues": [
      {
        "code": "invalid_type",
        "path": [
          "workspaceId"
        ],
        "message": "Required"
      },
      {
        "code": "custom",
        "path": [
          "file"
        ],
        "message": "Input not instance of File"
      }
    ]
  }
}

{
  "status_code": 429,
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "<string>"
}

This response has no body data.

POST

files

Upload a file

curl --request POST \
  --url https://api.steuerboard.com/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-client-id: <x-client-id>' \
  --form workspaceId=cmf41ajzv003706un4i99q19z \
  --form file='@example-file' \
  --form labelIds=cmf41ajzv003706un4i99q19z \
  --form name=document.pdf \
  --form folderId=cmf41ajzv003706un4i99q19z \
  --form taskId=cmf41ajzv003706un4i99q19z

import requests

url = "https://api.steuerboard.com/v1/files"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "workspaceId": "cmf41ajzv003706un4i99q19z",
    "labelIds": "cmf41ajzv003706un4i99q19z",
    "name": "document.pdf",
    "folderId": "cmf41ajzv003706un4i99q19z",
    "taskId": "cmf41ajzv003706un4i99q19z"
}
headers = {
    "x-client-id": "<x-client-id>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('workspaceId', 'cmf41ajzv003706un4i99q19z');
form.append('file', '<string>');
form.append('labelIds', 'cmf41ajzv003706un4i99q19z');
form.append('name', 'document.pdf');
form.append('folderId', 'cmf41ajzv003706un4i99q19z');
form.append('taskId', 'cmf41ajzv003706un4i99q19z');

const options = {
  method: 'POST',
  headers: {'x-client-id': '<x-client-id>', Authorization: 'Bearer <token>'}
};

options.body = form;

fetch('https://api.steuerboard.com/v1/files', 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.steuerboard.com/v1/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data",
    "x-client-id: <x-client-id>"
  ],
]);

$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.steuerboard.com/v1/files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--")

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

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.steuerboard.com/v1/files")
  .header("x-client-id", "<x-client-id>")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.steuerboard.com/v1/files")

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

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspaceId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labelIds\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ndocument.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folderId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"taskId\"\r\n\r\ncmf41ajzv003706un4i99q19z\r\n-----011000010111000001101001--"

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

{
  "id": "cmf41ajzv003706un4i99q19z",
  "documentDate": "2021-01-01T00:00:00Z",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "name": "document.pdf",
  "mimetype": "application/pdf",
  "size": 1024,
  "workspaceId": "cmf41ajzv003706un4i99q19z",
  "createdById": "cmf41ajzv003706un4i99q19z",
  "taskId": "cmf41ajzv003706un4i99q19z",
  "folderId": "cmf41ajzv003706un4i99q19z",
  "labelIds": [
    "cmf41ajzv003706un4i99q19z"
  ]
}

{
  "type": "bad_request",
  "message": "<string>"
}

{
  "status_code": 401,
  "type": "auth_error",
  "code": "unauthorized",
  "message": "<string>"
}

{
  "type": "auth_error",
  "message": "<string>"
}

{
  "type": "bad_request",
  "message": "<string>"
}

{
  "success": false,
  "error": {
    "name": "ValidationError",
    "issues": [
      {
        "code": "invalid_type",
        "path": [
          "workspaceId"
        ],
        "message": "Required"
      },
      {
        "code": "custom",
        "path": [
          "file"
        ],
        "message": "Input not instance of File"
      }
    ]
  }
}

{
  "status_code": 429,
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "<string>"
}

This response has no body data.

Authorizations

Authorization

string

header

required

Bearer token authentication

Headers

x-client-id

string<cuid>

required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"

Body

multipart/form-data

The file to upload

workspaceId

string<cuid>

required

The ID of the workspace

Example:

"cmf41ajzv003706un4i99q19z"

file

required

The file to upload

labelIds

string<cuid>[]

The IDs of the labels to add to the file

Example:

["cmf41ajzv003706un4i99q19z"]

name

string

The name of the file

Example:

"document.pdf"

folderId

string<cuid>

The ID of the folder to upload the file to

Example:

"cmf41ajzv003706un4i99q19z"

taskId

string<cuid>

The ID of the task to upload this file to.

Example:

"cmf41ajzv003706un4i99q19z"

Response

File created successfully

string<cuid>

required

The ID of the file

Example:

"cmf41ajzv003706un4i99q19z"

documentDate

string<date-time> | null

required

The date of the document (not the upload date)

Example:

"2021-01-01T00:00:00Z"

createdAt

string<date-time>

required

The date and time of the creation for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2021-01-01T00:00:00Z"

updatedAt

string<date-time>

required

The date and time of the last update for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2021-01-01T00:00:00Z"

name

string

required

The name of the file

Example:

"document.pdf"

mimetype

string

required

The mime type of the file

Example:

"application/pdf"

size

number

required

The size of the file in bytes

Example:

1024

workspaceId

string<cuid>

required

The ID of the workspace

Example:

"cmf41ajzv003706un4i99q19z"

createdById

string<cuid> | null

required

The ID of the creator

Example:

"cmf41ajzv003706un4i99q19z"

taskId

string<cuid> | null

required

The ID of the task this file was uploaded to.

Example:

"cmf41ajzv003706un4i99q19z"

folderId

string<cuid> | null

required

The ID of the folder this file was uploaded to.

Example:

"cmf41ajzv003706un4i99q19z"

labelIds

string<cuid>[] | null

required

The IDs of the assigned labels

Example:

["cmf41ajzv003706un4i99q19z"]

List files Get a file