Skip to content

uploadFile

POST
/v1/files
curl --request POST \
--url https://example.com/v1/files \
--header 'Content-Type: multipart/form-data' \
--form upload_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--form workspace_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--form purpose=image \
--form file=@file
Media typemultipart/form-data
object
upload_id
required

A fresh UUID for this upload; reuse it only to retry identical content.

string format: uuid
workspace_id
required
string format: uuid
purpose
required
string
Allowed values: image inspection_report certificate asset conformity_declaration data_sheet qr export
file
required

One file, 1 byte to 4 MiB (4,194,304 bytes). Larger files return HTTP 413 before any backend call.

string format: binary

Uploaded file

Media typeapplication/json
object
id
required
string format: uuid
name
required
string
mime_type
required
string
size
required
integer
> 0

Example generated

{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"mime_type": "example",
"size": 1
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Request could not be completed

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}